> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paperzilla.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI getting started

> Install pz, sign in, create your first project, and learn the first commands to run.

export const AiAgents = ({path}) => <Tip>
    <b>AI agents</b>: This page is available as <a href={path + '.md'}>markdown</a>. See also the <a href="/llms.txt">docs index</a> and <a href="/llms-full.txt">full docs</a>.
  </Tip>;

<AiAgents path="/guides/cli-getting-started" />

This is the fastest path from installing `pz` to getting useful output.

## What the CLI expects

The Paperzilla CLI supports two modes:

* canonical paper mode
* project mode

Canonical paper mode works with a Paperzilla paper ID and does not require login.

Project mode works against your existing Paperzilla account and projects. That means:

* you need a Paperzilla account
* you need at least one project
* then `pz` can list projects, browse or search feeds, open recommendations, leave feedback, print markdown, and generate Atom feed URLs

If you installed `pz` first and have not set up Paperzilla yet, that is fine. Start with the web app once, then come back to the CLI.

## Step 1: install pz

Follow the install instructions in the [CLI guide](/guides/cli).

## Step 2: if you already have a Paperzilla paper ID, open it immediately

```bash theme={null}
pz paper <paper-id>
```

That works without logging in.

To keep the CLI up to date:

```bash theme={null}
pz update
```

That command checks whether you are on the latest release and prints the right upgrade steps for Homebrew, Scoop, GitHub release installs, or source builds.

## Step 3: sign in for project commands

```bash theme={null}
pz login
```

Paperzilla sends a one-time email code and stores your session locally for reuse.

## Step 4: if you do not have an account yet

Go to [paperzilla.ai](https://paperzilla.ai) and follow the [quickstart](/quickstart).

The short version:

1. Describe what research you want to track.
2. Review the proposed project setup.
3. Save delivery.
4. Confirm your email if prompted.

That creates both your account access and your first project.

## Step 5: if you signed in but have no projects

Run:

```bash theme={null}
pz project list
```

If you see no projects, create your first one in the web app:

* [How do I create my first project?](/answers/create-first-project)
* [What is a project in Paperzilla?](/answers/what-is-a-project)

## Step 6: run your first useful commands

List projects:

```bash theme={null}
pz project list
```

For scripts and agents, use `pz project list --json` to get the same project identity fields as structured output: `id`, `name`, `mode`, and `visibility`.

Browse a project feed:

```bash theme={null}
pz feed <project-id>
```

Find a project ID, then search across the full feed:

```bash theme={null}
pz project list
pz feed search --project-id <project-id> --query "latent retrieval"
```

Inspect a canonical paper by Paperzilla paper ID:

```bash theme={null}
pz paper <paper-id>
```

Inspect one recommendation from the feed:

```bash theme={null}
pz rec <project-paper-id>
```

Open a canonical paper with project context:

```bash theme={null}
pz paper <paper-id> --project <project-id>
```

Leave recommendation feedback:

```bash theme={null}
pz feedback <project-paper-id> upvote
```

Use `pz feedback <project-paper-id> upvote --json` when you want the feedback object as structured output.

Print raw paper markdown:

```bash theme={null}
pz rec <project-paper-id> --markdown
```

Get an Atom feed URL:

```bash theme={null}
pz feed <project-id> --atom
```

Update the CLI:

```bash theme={null}
pz update
```

If needed, override install-method detection:

```bash theme={null}
pz update --install-method source
```

## If your project exists but has no papers yet

That usually means the project is still processing, paused, too narrow, or too strict.

See:

* [Why does my project have no papers yet?](/answers/project-no-papers)

## Next docs

* [CLI guide](/guides/cli)
* [RSS and Atom feeds](/guides/feeds)
* [In-app feed](/guides/feed-in-app)
* [MCP guide](/guides/mcp)