Getting Started
Install the Faurya CLI, view help, log in, verify your account, and find website IDs.
Getting Started
This guide gets the faurya command ready for normal user workflows.
Requirements
The CLI package requires Node.js 20 or newer.
node --versionInstall the CLI
Install the current public package globally with npm:
npm install --global @faurya/cliYou can also run the package without a global install when you only need a one-off command:
npx @faurya/cli --versionVerify the installation
faurya --versionView help
Global help lists command groups, output flags, and examples.
faurya --helpYou can view group help:
faurya analytics --helpYou can also view command-specific help:
faurya analytics overview --helpThe help command accepts the same command path:
faurya help website dashboardLog in
Run login in an interactive terminal and provide your Faurya user credential when prompted.
faurya loginCheck the current account
Use whoami for a quick account check.
faurya whoamiUse account get when you need the account command group form.
faurya account getList accessible websites
Most commands require a website ID. List websites available to your current account:
faurya website listPlaceholder syntax
Documentation uses angle-bracket placeholders for values you must replace:
| Placeholder | Meaning |
|---|---|
<websiteId> | The Faurya website to query or manage. |
<visitorId> | A visitor identifier returned by visitor analytics. |
<sessionId> | A session identifier returned by session analytics. |
<funnelId> | A saved funnel identifier. |
<alertId> | An alert identifier. |
<memberId> | The team member identifier used by teams remove; removal also requires the member email in structured input. |
<tokenId> | A site API-key record identifier. |
<provider> | A supported revenue provider such as stripe or paddle. |
Do not type the angle brackets in real commands.
Log out
faurya logoutLogging out removes the stored local credential. If a command still authenticates after logout, check whether your shell or automation environment is supplying credentials outside the stored login flow.