Faurya CLI

Output and Errors

Understand Faurya CLI output flags, stdout and stderr behavior, exit codes, and common error categories.

Output and Errors

The CLI supports several output and diagnostic flags. This documentation does not include example command results.

Output flags

FlagUse case
Default outputHuman-readable where supported; command data is printed to standard output.
--jsonStructured JSON output for scripting and automation.
--jsonlNewline-delimited JSON where supported.
--rawRaw scalar output where supported; non-scalar values are serialized.
--quietSuppress non-error human output.
--verboseInclude safe diagnostics on errors.
faurya analytics overview <websiteId> --period last30d --json
faurya analytics events list <websiteId> --period last24h --jsonl
faurya whoami --quiet

Standard output and standard error

  • Successful command data is written to standard output.
  • Error messages are written to standard error.
  • Use --json when another program needs to parse command results or errors.
  • Use --quiet when a script only needs exit status and errors.

Exit codes

Exit codeMeaning
0Success.
2Invalid arguments, unknown command, invalid input, or confirmation missing.
3Authentication failed or missing.
4Authorization failed.
5Requested resource was not found.
6Conflict.
7Rate limited.
8Network, timeout, server, or unexpected failure.
130Interrupted or cancelled.

Common error categories

CategoryTypical causeWhat to do
Invalid argumentsUnknown command, unknown option, invalid period, invalid filter, invalid JSON, or missing required input.Re-run command-specific help and correct the command.
AuthenticationNo valid login, expired access, or revoked credential.Log in again and verify whoami.
AuthorizationCredential lacks website, feature, or role access.Check the website ID and ask an owner or admin to grant access.
Not foundWebsite or resource ID does not exist or is not available to the credential.Re-list resources and copy the ID again.
ConflictThe requested change conflicts with current state.Refresh current state and retry with updated input.
Rate limitedToo many requests in a short period.Wait before retrying; reduce script concurrency.
Network or serverConnectivity, timeout, or service-side problem.Retry later or contact support with the safe request context from your terminal.
InterruptedUser cancelled an interactive prompt or interrupted the process.Re-run when ready.

Help commands for diagnosis

faurya --help
faurya analytics --help
faurya analytics journeys find --help
faurya website domain remove --help