Faurya CLI

Faurya CLI

Install and use the Faurya command-line interface for analytics, setup, website management, teams, alerts, funnels, and site API keys.

Faurya CLI

The Faurya CLI is the official command-line interface for working with Faurya from a terminal. It is useful for website owners, growth teams, analysts, developers, and operators who want fast access to analytics and approved website-management workflows without opening the dashboard.

Use it to inspect traffic, visitors, sessions, events, goals, revenue, paths, cohorts, attribution, campaigns, AI crawls, funnels, alerts, team members, website settings, integration setup instructions, and site API keys.

Main capabilities

  • Authenticate and confirm the active Faurya account.
  • List websites available to your account.
  • Query analytics using periods, filters, dimensions, pagination, and output formats.
  • Analyze journeys, paths, goals, funnels, cohorts, payments, revenue, attribution, and change trends.
  • Create, update, analyze, and delete saved funnels.
  • Retrieve tracking, goal, widget, AI crawler, revenue integration, and webhook setup instructions.
  • Manage safe website settings, domains, dashboard layout, widgets, reports, and tracking exclusions.
  • Manage team members and alerts.
  • Manage site API keys with the tokens commands.

Prerequisites

The current CLI package requires Node.js 20 or newer and is distributed as the npm package @faurya/cli with the executable name faurya.

Install

npm install --global @faurya/cli

Quick start

faurya login
faurya whoami
faurya website list
faurya analytics overview <websiteId> --period last30d

Explore the CLI docs