Skip to main content
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.

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

pz paper <paper-id>
That works without logging in. To keep the CLI up to date: 
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

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 and follow the 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: 
pz project list
If you see no projects, create your first one in the web app:

​
Step 6: run your first useful commands

List projects: 
pz project list
Browse a project feed: 
pz feed <project-id>
Find a project ID, then search across the full feed: 
pz project list
pz feed search --project-id <project-id> --query "latent retrieval"
Inspect a canonical paper by Paperzilla paper ID: 
pz paper <paper-id>
Inspect one recommendation from the feed: 
pz rec <project-paper-id>
Open a canonical paper with project context: 
pz paper <paper-id> --project <project-id>
Leave recommendation feedback: 
pz feedback <project-paper-id> upvote
Print raw paper markdown: 
pz rec <project-paper-id> --markdown
Get an Atom feed URL: 
pz feed <project-id> --atom
Update the CLI: 
pz update
If needed, override install-method detection: 
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:

​
Next docs