@vibepaper/cli

VibePaper developer CLI: OAuth login, asset upload, model discovery, generate/edit jobs.

Requirements

The standalone installer does not need Node.js. The optional npm package requires Node.js >= 22.12.0.

Install

Mac:

curl -fsSL https://vibepaper-ai.com/cli/install.sh | bash

Linux:

curl -fsSL https://vibepaper-ai.com/cli/install.sh | bash

Windows:

irm https://vibepaper-ai.com/cli/install.ps1 | iex

Optional npm (requires Node.js >= 22.12.0):

npm i -g @vibepaper/cli

Monorepo local dev:

pnpm --filter @vibepaper/cli build
cd packages/cli && npm link

Agent setup (recommended)

Copy to Codex / Claude Code / Cursor terminal agent:

Set up VibePaper for me so I can generate and edit images, video, audio, and text, and work on an existing canvas from here. Do not use npm. Do not change the global Node.js install.

1. Install the CLI. Pick the command for this computer:
   - Mac: `curl -fsSL https://vibepaper-ai.com/cli/install.sh | bash`
   - Linux: `curl -fsSL https://vibepaper-ai.com/cli/install.sh | bash`
   - Windows: `irm https://vibepaper-ai.com/cli/install.ps1 | iex`
2. Authenticate: run `vibepaper auth login` and complete sign-in in the browser it opens.
3. Verify: run `vibepaper auth status`.

Once that's done, let me know when it's ready.

Web guide: vibepaper-ai.com/papermcp (CLI tab).

Standalone binaries: GitHub Releases (tag cli-v*). Optional npm: npm i -g @vibepaper/cli if you already have Node.js 22.12+.

Login

vibepaper auth login

Test API:

vibepaper auth login --api-base-url https://test-api.vibepaper-ai.com

Credentials: ~/.vibepaper/credentials.json

Common commands

vibepaper version
vibepaper auth status
vibepaper account status

vibepaper model list --kind image
vibepaper model get z-image-turbo

vibepaper upload ./photo.png --kind image
vibepaper asset list

vibepaper generate create z-image-turbo --prompt "a cat in watercolor" --yes --wait
vibepaper generate list --limit 20
vibepaper generate cancel <jobId>

vibepaper edit create --operation image_upscale --asset <assetId> --param resolution 2k --yes --wait
vibepaper job outputs <jobId>

vibepaper canvas connect --json
vibepaper canvas import <canvasId> ./photo.jpg --json

Add --json for machine-readable output.

Pagination

vibepaper generate list --cursor-created-at 2026-01-01T00:00:00.000Z --cursor-job-id <jobId>
vibepaper asset list --cursor-created-at 2026-01-01T00:00:00.000Z --cursor-asset-id <assetId>

Non-JSON list output prints the next-page flags on stderr when more results exist.

Exit codes

| Code | Meaning | |------|---------| | 0 | Success | | 1 | General error | | 2 | Auth required / expired | | 3 | Payment / insufficient points | | 4 | Forbidden | | 5 | Not found |

MCP

Browser agents (Cursor / ChatGPT / Claude web) should use PaperMCP OAuth — see vibepaper-ai.com/papermcp.

CLI is for terminal agents and local file paths.