Skip to content
proton-cli

Command reference

Every command, every argument and every flag, generated from the command tree.

proton <app> <collection> <verb> [TARGET...] [--flags]

Anywhere a command shows REF, you can pass a full ID, the eight-character short ID a list printed, or something human: a subject, a name, a path, an email address. See References.

  • proton account - your Proton account, its settings and your session. 10 commands.
  • proton api - send a raw authenticated request to the Proton API. 1 command.
  • proton itself - updating, uninstalling, completions and what a release changed. 5 commands.

These are declared on the root, so they can be given to any command and mean the same thing on all of them.

Flag Description
-n, --dry-run Preview mutations without applying them
--full-ids Show full IDs in interactive output (default: shortened to 8 chars on TTY)
--log-level string Logging verbosity: debug, info, warn, error (env: PROTON_LOG_LEVEL)
--no-color Disable colored output (env: NO_COLOR)
--no-input Never prompt; a missing credential becomes an error (env: PROTON_NO_INPUT)
-o, --output string Output format: text, json, yaml (default text)
-p, --profile string Profile to act as (env: PROTON_PROFILE; default: default)
-q, --quiet Suppress non-essential stderr output
-y, --yes Answer confirmation prompts with yes

See Configuration for what each one changes, and Output for the exit codes.