Faurya CLI
Command Reference
Exhaustive public Faurya CLI command index with signatures, purpose, required arguments, flags, data-change behavior, and links.
Command Reference
This page lists the public command surface exposed by the current CLI package, including analytics aliases. Use command-specific help as the live terminal reference.
faurya --helpfaurya analytics overview --helpGlobal flags
| Flag | Purpose |
|---|---|
--json | Print structured command results and errors as JSON. |
--jsonl | Print newline-delimited JSON where supported. |
--pretty | Use human-readable output where supported. |
--raw | Print raw scalar output where supported. |
--quiet | Suppress non-error human output. |
--verbose | Include safe diagnostics on errors. |
-h, --help | Show help. |
-V, --version | Print the CLI version. |
Local authentication and configuration
| Command | Purpose | Required arguments | Important flags | Changes data | Details |
|---|---|---|---|---|---|
faurya login | Store or validate a Faurya user login. | None | Output flags | Yes, local credential only | Authentication |
faurya logout | Remove the stored local login credential. | None | Output flags | Yes, local credential only | Authentication |
faurya whoami | Show the active Faurya account. | None | Output flags | No | Authentication |
faurya account get | Read the current Faurya account. | None | Output flags | No | Authentication |
faurya config show | Inspect local CLI configuration and credential source. | None | Output flags | No | Output and Errors |
Website commands
| Command | Purpose | Required arguments | Important flags | Changes data | Details |
|---|---|---|---|---|---|
faurya website list | List accessible websites. | None | Output flags | No | Website Management |
faurya website show <websiteId> | Show safe website settings. | <websiteId> | Output flags | No | Website Management |
faurya website update <websiteId> | Update safe website settings. | <websiteId> | --input, --input-file | Yes | Website Management |
faurya website kpi set <websiteId> | Set the primary KPI. | <websiteId> | --kpi, --input, --input-file | Yes | Website Management |
faurya website name set <websiteId> | Set the website display name. | <websiteId> | --name, --input, --input-file | Yes | Website Management |
faurya website domain set <websiteId> | Set the primary domain. | <websiteId> | --input, --input-file | Yes | Website Management |
faurya website domain add <websiteId> | Add an additional domain. | <websiteId> | --input, --input-file | Yes | Website Management |
faurya website domain remove <websiteId> | Remove an additional domain. | <websiteId> | --input, --input-file, --yes | Yes, destructive | Destructive Commands |
faurya website dashboard show <websiteId> | Show dashboard configuration. | <websiteId> | Output flags | No | Website Management |
faurya website dashboard layout <websiteId> | Update dashboard layout order. | <websiteId> | --input, --input-file | Yes | Website Management |
faurya website dashboard ai-crawl-card <websiteId> | Enable or disable the AI crawl dashboard card. | <websiteId> | --input, --input-file | Yes | Website Management |
faurya website widgets list <websiteId> | List widget types. | <websiteId> | Output flags | No | Setup and Integrations |
faurya website widgets embed <websiteId> | Retrieve widget embed instructions. | <websiteId> | --input, --input-file | No | Setup and Integrations |
faurya website widgets settings <websiteId> | Show widget settings. | <websiteId> | Output flags | No | Website Management |
faurya website widgets enable <websiteId> | Enable or disable widgets. | <websiteId> | --input, --input-file | Yes | Website Management |
faurya website reports show <websiteId> | Show report settings. | <websiteId> | Output flags | No | Website Management |
faurya website reports enable <websiteId> | Enable or disable weekly reports. | <websiteId> | --input, --input-file | Yes | Website Management |
faurya website exclusions list <websiteId> | List tracking exclusions. | <websiteId> | Output flags | No | Website Management |
faurya website exclusions add <websiteId> | Add a tracking exclusion. | <websiteId> | --input, --input-file | Yes | Website Management |
faurya website exclusions remove <websiteId> | Remove a tracking exclusion. | <websiteId> | --input, --input-file, --yes | Yes, destructive | Destructive Commands |
Setup and integration commands
| Command | Purpose | Required arguments | Important flags | Changes data | Details |
|---|---|---|---|---|---|
faurya website setup tracking <websiteId> | Retrieve a tracking setup plan. | <websiteId> | --input, --input-file | No | Setup and Integrations |
faurya website setup code <websiteId> | Retrieve tracking code instructions. | <websiteId> | --input, --input-file | No | Setup and Integrations |
faurya website setup config <websiteId> | Retrieve tracking configuration reference. | <websiteId> | --input, --input-file | No | Setup and Integrations |
faurya website setup validate <websiteId> | Validate tracking setup input. | <websiteId> | --input, --input-file | No | Setup and Integrations |
faurya website setup goal-code <websiteId> | Retrieve goal tracking code instructions. | <websiteId> | --input, --input-file | No | Setup and Integrations |
faurya website setup scroll-goal <websiteId> | Retrieve scroll-goal tracking code instructions. | <websiteId> | --input, --input-file | No | Setup and Integrations |
faurya website setup goal-reference <websiteId> | Retrieve goal tracking reference. | <websiteId> | --input, --input-file | No | Setup and Integrations |
faurya website setup ai-crawl <websiteId> | Retrieve AI crawler setup guide. | <websiteId> | --input, --input-file | No | Setup and Integrations |
faurya website setup ai-crawl-config <websiteId> | Retrieve AI crawler configuration summary. | <websiteId> | Output flags | No | Setup and Integrations |
faurya website integrations list <websiteId> | List revenue integrations. | <websiteId> | Output flags | No | Setup and Integrations |
faurya website integrations status <websiteId> <provider> | Show provider integration status. | <websiteId>, <provider> | Output flags | No | Setup and Integrations |
faurya website integrations setup <websiteId> <provider> | Retrieve provider setup guide. | <websiteId>, <provider> | --input, --input-file | No | Setup and Integrations |
faurya website integrations webhook <websiteId> <provider> | Retrieve payment webhook configuration. | <websiteId>, <provider> | Output flags | No | Setup and Integrations |
Analytics commands and aliases
| Command | Purpose | Required arguments | Important flags | Changes data | Details |
|---|---|---|---|---|---|
faurya analytics context <websiteId> | Show analytics context and data coverage. | <websiteId> | Output flags | No | Analytics |
faurya analytics catalog <websiteId> | List supported metrics, dimensions, operators, and catalog values. | <websiteId> | Output flags | No | Analytics |
faurya analytics dimensions <websiteId> <field> | List values for a public dimension. | <websiteId>, <field> | --period, --from, --to, --limit | No | Analytics |
faurya analytics overview <websiteId> | Run semantic analytics overview queries. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics timeseries <websiteId> | Run analytics in timeseries mode. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics breakdown <websiteId> <dimension> | Break analytics down by one dimension. | <websiteId>, <dimension> | Data flags, filters | No | Analytics |
faurya analytics pages <websiteId> | Show top page paths. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics referrers <websiteId> | Show top referrers. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics countries <websiteId> | Show top countries. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics regions <websiteId> | Show top regions. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics cities <websiteId> | Show top cities. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics browsers <websiteId> | Show top browsers. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics os <websiteId> | Show top operating systems. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics devices <websiteId> | Show top devices. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics campaigns <websiteId> | Show top campaigns. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics hostnames <websiteId> | Show top hostnames. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics realtime <websiteId> | Show recent active visitors and events. | <websiteId> | Output flags | No | Analytics |
faurya analytics visitors list <websiteId> | List visitors with pagination and filters. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics visitors get <websiteId> <visitorId> | Get one visitor profile and activity summary. | <websiteId>, <visitorId> | Output flags | No | Analytics |
faurya analytics visitors trace <websiteId> <visitorId> | Trace one visitor chronologically. | <websiteId>, <visitorId> | --limit, --cursor | No | Analytics |
faurya analytics sessions list <websiteId> | List sessions with pagination and filters. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics sessions get <websiteId> <sessionId> | Get one reconstructed session timeline. | <websiteId>, <sessionId> | Output flags | No | Analytics |
faurya analytics events list <websiteId> | List visible events with pagination and filters. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics journeys find <websiteId> | Find journeys matching ordered steps. | <websiteId> | --input, --input-file | No | Analytics |
faurya analytics goals <websiteId> | Analyze goal completions and conversion rates. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics paths <websiteId> | Analyze top visible paths. | <websiteId> | --input, --input-file | No | Analytics |
faurya analytics cohorts <websiteId> | Analyze visitor cohorts and retention. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics payments <websiteId> | Search payment events. | <websiteId> | Data flags, filters, --input | No | Analytics |
faurya analytics revenue <websiteId> | Analyze tracked revenue. | <websiteId> | Data flags, filters | No | Analytics |
faurya analytics attribution <websiteId> | Analyze attribution models. | <websiteId> | Data flags, filters, --input | No | Analytics |
faurya analytics ai-crawls <websiteId> | Query AI crawler analytics. | <websiteId> | Data flags, filters, --input | No | Analytics |
faurya analytics changes <websiteId> | Compare periods and segment changes. | <websiteId> | --input, --input-file | No | Analytics |
Data flags are documented in Filters, Periods, and Pagination.
Funnels, teams, alerts, and site API keys
| Command | Purpose | Required arguments | Important flags | Changes data | Details |
|---|---|---|---|---|---|
faurya funnels analyze <websiteId> | Analyze an unsaved funnel. | <websiteId> | --input, --input-file | No | Funnels |
faurya funnels list <websiteId> | List saved funnels. | <websiteId> | --limit, --cursor | No | Funnels |
faurya funnels get <websiteId> <funnelId> | Get one saved funnel. | <websiteId>, <funnelId> | Output flags | No | Funnels |
faurya funnels create <websiteId> | Create a saved funnel. | <websiteId> | --input, --input-file, --name | Yes | Funnels |
faurya funnels update <websiteId> <funnelId> | Update a saved funnel. | <websiteId>, <funnelId> | --input, --input-file, --name | Yes | Funnels |
faurya funnels delete <websiteId> <funnelId> | Delete a saved funnel. | <websiteId>, <funnelId> | --yes | Yes, destructive | Destructive Commands |
faurya teams list <websiteId> | List team members. | <websiteId> | Output flags | No | Teams |
faurya teams invite <websiteId> | Invite a team member. | <websiteId> | --input, --input-file | Yes | Teams |
faurya teams remove <websiteId> <memberId> | Remove a team member. | <websiteId>, <memberId> | --input, --input-file, --yes | Yes, destructive | Teams |
faurya alerts template-reference <websiteId> | Show alert template variable reference. | <websiteId> | Output flags | No | Alerts |
faurya alerts list <websiteId> | List alerts. | <websiteId> | Output flags | No | Alerts |
faurya alerts create <websiteId> | Create an alert. | <websiteId> | --input, --input-file, --name | Yes | Alerts |
faurya alerts update <websiteId> <alertId> | Update an alert. | <websiteId>, <alertId> | --input, --input-file, --name | Yes | Alerts |
faurya alerts delete <websiteId> <alertId> | Delete an alert. | <websiteId>, <alertId> | --yes | Yes, destructive | Destructive Commands |
faurya tokens list <websiteId> | List active site API keys as metadata. | <websiteId> | Output flags | No | Site API Keys |
faurya tokens create <websiteId> | Create a site API key. | <websiteId> | --name, --input, --input-file | Yes | Site API Keys |
faurya tokens get <websiteId> <tokenId> | Read one site API-key metadata record. | <websiteId>, <tokenId> | Output flags | No | Site API Keys |
faurya tokens rotate <websiteId> <tokenId> | Rotate a site API key. | <websiteId>, <tokenId> | --yes | Yes, destructive | Site API Keys |
faurya tokens revoke <websiteId> <tokenId> | Revoke a site API key. | <websiteId>, <tokenId> | --yes | Yes, destructive | Site API Keys |
Authentication
Log in to the Faurya CLI, confirm account identity, understand site-scoped access, and handle denied access.
Analytics
Use Faurya CLI analytics commands for overview, realtime, timeseries, breakdowns, visitors, sessions, events, journeys, goals, paths, cohorts, payments, revenue, attribution, AI crawls, and changes.