CLI reference - Lettercamp

Use the Lettercamp CLI to create, preview, and publish a publication. Each guide below documents one command or workflow, including its options and examples. In a project created with npm create lettercamp@latest, run commands as npx lettercamp <command>. A global installation also supports lettercamp <command> directly.

Command reference

Command	Purpose
`lettercamp new [directory]`	Create a publication from the starter.
`lettercamp connect <code>`	Connect an agent and download a cloud site’s source.
`lettercamp pull`	Fetch remote source while preserving local edits.
`lettercamp push`	Save a checkpoint and build a cloud preview without publishing.
`lettercamp status`	Show local/remote changes and preview build errors.
`lettercamp posts <command>`	Find, read, create, and revise shared posts in the cloud editor.
`lettercamp assets list`	Search the connected site’s media library and recover previous uploads.
`lettercamp publish`	Queue all saved page changes using a publishing-enabled connection.
`lettercamp dev`	Preview your publication with live reload.
`lettercamp check`	Check imports and build a temporary Cloud deployment copy without uploading.
`lettercamp deploy`	Create a site on first use, then update this folder’s site.
`lettercamp deploy --new`	Create another site and use it for future deployments from this folder.
`lettercamp domain [address]`	Connect a hostname or subfolder, or check and resume setup.
`lettercamp domain remove`	Disconnect the custom address after confirmation.
`lettercamp login`	Authorize the CLI through your browser.
`lettercamp whoami`	Show the signed-in account.
`lettercamp logout`	Revoke the current CLI session.
`lettercamp upload <files...>`	Upload images, fonts, or videos and print their hosted URLs.
`lettercamp build --site <url>`	Build a static publication for hosting.
`lettercamp version`	Show the installed and latest published versions.
`lettercamp update`	Update the project’s CLI, or use `--global` for a global npm installation.
`lettercamp --version`	Show the installed version.
`lettercamp --help`	List available commands.

Add --help to a command to see its arguments and options:

npx lettercamp build --help

Setup and help

Install and update the CLI, including Node.js requirements.
Subfolder hosting for an address such as example.com/blog.
Troubleshooting for setup, preview, and publishing problems.
Content components for supported article blocks.