Website Management
Manage Faurya websites, safe settings, domains, dashboard layout, widgets, reports, and tracking exclusions from the CLI.
Website Management
Website management commands operate on one <websiteId> unless noted. Commands that change configuration require write access for the website.
List websites
faurya website listShow website settings
faurya website show <websiteId>Update safe settings
website update accepts timezone and currency. At least one explicit setting is required.
faurya website update <websiteId> --input '{"timezone":"UTC"}'faurya website update <websiteId> --input '{"currency":"USD"}'Set the primary KPI
Use --kpi for the simplest form. Accepted values are visitor, payment, or a configured goal name.
faurya website kpi set <websiteId> --kpi visitorfaurya website kpi set <websiteId> --kpi paymentThe structured field is primaryKpi.
faurya website kpi set <websiteId> --input '{"primaryKpi":"signup"}'Set the website name
faurya website name set <websiteId> --name "Example Site"faurya website name set <websiteId> --input '{"name":"Example Site"}'Set the primary domain
faurya website domain set <websiteId> --input '{"domain":"example.com"}'Add an additional domain
faurya website domain add <websiteId> --input '{"domain":"app.example.com"}'Remove an additional domain
This command is destructive because it removes a tracked hostname from the website configuration.
faurya website domain remove <websiteId> --input '{"domain":"app.example.com"}'faurya website domain remove <websiteId> --input '{"domain":"app.example.com"}' --yesView dashboard configuration
faurya website dashboard show <websiteId>Update dashboard layout
Use componentOrder with 1 to 4 component identifiers.
faurya website dashboard layout <websiteId> --input '{"componentOrder":["kpis","chart","sources","pages"]}'Enable or disable the AI crawl card
faurya website dashboard ai-crawl-card <websiteId> --input '{"enabled":true}'faurya website dashboard ai-crawl-card <websiteId> --input '{"enabled":false}'View widget types
faurya website widgets list <websiteId>Retrieve widget embed instructions
widgetType must be realtime, analytics, or chart. Optional fields include mainTextSize, primaryColor, secondaryColor, barColor, width, height, and loading.
faurya website widgets embed <websiteId> --input '{"widgetType":"realtime"}'faurya website widgets embed <websiteId> --input '{"widgetType":"chart","loading":"lazy"}'View widget settings
faurya website widgets settings <websiteId>Enable or disable widgets
faurya website widgets enable <websiteId> --input '{"enabled":true}'faurya website widgets enable <websiteId> --input '{"enabled":false}'View report settings
faurya website reports show <websiteId>Enable or disable weekly reports
faurya website reports enable <websiteId> --input '{"enabled":true}'faurya website reports enable <websiteId> --input '{"enabled":false}'List tracking exclusions
faurya website exclusions list <websiteId>Add tracking exclusions
Supported exclusion types are hostname, ip, and path.
faurya website exclusions add <websiteId> --input '{"type":"hostname","value":"internal.example.com"}'faurya website exclusions add <websiteId> --input '{"type":"path","value":"/internal"}'Remove tracking exclusions
This command is destructive because it removes an exclusion rule.
faurya website exclusions remove <websiteId> --input '{"type":"path","value":"/internal"}'faurya website exclusions remove <websiteId> --input '{"type":"path","value":"/internal"}' --yes