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
| Flag | Use case |
|---|---|
| Default output | Human-readable where supported; command data is printed to standard output. |
--json | Structured JSON output for scripting and automation. |
--jsonl | Newline-delimited JSON where supported. |
--raw | Raw scalar output where supported; non-scalar values are serialized. |
--quiet | Suppress non-error human output. |
--verbose | Include safe diagnostics on errors. |
faurya analytics overview <websiteId> --period last30d --jsonfaurya analytics events list <websiteId> --period last24h --jsonlfaurya whoami --quietStandard output and standard error
- Successful command data is written to standard output.
- Error messages are written to standard error.
- Use
--jsonwhen another program needs to parse command results or errors. - Use
--quietwhen a script only needs exit status and errors.
Exit codes
| Exit code | Meaning |
|---|---|
0 | Success. |
2 | Invalid arguments, unknown command, invalid input, or confirmation missing. |
3 | Authentication failed or missing. |
4 | Authorization failed. |
5 | Requested resource was not found. |
6 | Conflict. |
7 | Rate limited. |
8 | Network, timeout, server, or unexpected failure. |
130 | Interrupted or cancelled. |
Common error categories
| Category | Typical cause | What to do |
|---|---|---|
| Invalid arguments | Unknown command, unknown option, invalid period, invalid filter, invalid JSON, or missing required input. | Re-run command-specific help and correct the command. |
| Authentication | No valid login, expired access, or revoked credential. | Log in again and verify whoami. |
| Authorization | Credential lacks website, feature, or role access. | Check the website ID and ask an owner or admin to grant access. |
| Not found | Website or resource ID does not exist or is not available to the credential. | Re-list resources and copy the ID again. |
| Conflict | The requested change conflicts with current state. | Refresh current state and retry with updated input. |
| Rate limited | Too many requests in a short period. | Wait before retrying; reduce script concurrency. |
| Network or server | Connectivity, timeout, or service-side problem. | Retry later or contact support with the safe request context from your terminal. |
| Interrupted | User cancelled an interactive prompt or interrupted the process. | Re-run when ready. |
Help commands for diagnosis
faurya --helpfaurya analytics --helpfaurya analytics journeys find --helpfaurya website domain remove --help