Skip to main content

Global flags

Flags the CLI accepts on any command, before or after the command name.

Output and help​

FlagDescription
--agent-helpPrint the long agent handbook.
--formatOutput format: json or text (default: auto-detect TTY).
--global-helpLegacy alias for --agent-help.
--helpShow help.
--jsonForce JSON output.
--no-configIgnore the nearest .perpetual.toml.
--profileNamed profile to use for auth (or PERPETUAL_PROFILE env var).
--robot-statusPrint machine-readable CLI and auth status.
--textForce text output.
--versionShow CLI version.

Also accepted: -h, -v.

Sign-in flags​

These choose who a command signs in as. Each command's page says whether it takes them.

FlagDescription
--emailUser email (or PERPETUAL_EMAIL env var).
--org-idOrganization ID for this command; beats PERPETUAL_ORG_ID, .perpetual.toml and the stored org.
--passwordUser password (DEPRECATED: visible in ps/history. Use --password-file or --password-stdin).
--password-fileRead password from a file (first line).
--password-stdinRead password from stdin.

Perpetual CLI 0.5.0