Commands
The `papermark` command tree, organized by noun.
The CLI groups commands by the resource they act on. Run any command
with --help for the full flag list; these pages cover the parts
worth reading once.
| Group | Use it for |
|---|---|
| documents | List, get, search, upload, delete documents |
| datarooms | Create, configure, audit, and read analytics for datarooms |
| links | Create, list, get, delete share links (document- or dataroom-bound) |
| views | Read view analytics for a link |
| config | Per-machine settings (e.g., custom API URL) |
Auth-related commands (login, logout, whoami, auth export,
auth set, doctor) live on the
Authentication page; they make more
sense in that context.
Global flags
These work on every command:
| Flag | Effect |
|---|---|
--json | Force JSON output (auto-enabled when piped) |
--dry-run | Print the HTTP request and exit 0 (token redacted) |
--no-color | Disable ANSI color (equiv. to NO_COLOR=1) |
Aliases
papermark documents accepts papermark doc as an alias. Tab
completion picks up either.
The output contract
Everything every command emits, success or failure, is documented in the output contract. Pin to it.