# Use Attriboo from your terminal

The Attriboo CLI reads your reports from a terminal and exports JSON or CSV. Owners and admins can separately approve website setup. You still complete sign-in, approve access and authorize any website deployment or payment connection.

Canonical page: https://www.attriboo.com/docs/cli

Instructions reviewed: 2026-10-31

## Install the official download

Install Node.js 20 or newer, then run the command below. This package is downloaded from Attriboo. No npm account is required.

Install Attriboo CLI 0.1.1

```
npm install -g https://www.attriboo.com/downloads/attriboo-cli-0.1.1.tgz
attriboo --version
attriboo login
```

- [Download Node.js from its official website](https://nodejs.org/en/download)

## Sign in and choose a website

1. **Run attriboo login.** A browser opens on this computer. Complete email sign-in or account creation yourself, choose a workspace and approve report access.

2. **Return to the terminal.** Wait for signed_in to be true. Use attriboo login --no-browser if the automatic browser opening is unavailable; open its link on the same computer.

3. **Run attriboo sites list.** Use an actual website ID or domain from the returned list. Never invent an ID.

Read a website report

```
attriboo sites list
attriboo reports overview --site example.com --period 30d
attriboo reports sources --site example.com --period mtd --model first_touch
```

## Export reports with clear units

Add --json for compact JSON or --csv for rows you can save with shell redirection. The default output is formatted JSON. Money remains integer cents in the selected website currency. Keep the date range and model beside exported figures.

Reports include overview, timeseries, sources, channels, campaigns, pages, hostnames, countries, cities, devices, browsers, os, goals, sales, funnels, ai-search, time-to-purchase and realtime. Run attriboo --help for options. CSV uses a report's main row collection; nested values stay JSON cells.

Save source rows or a campaign report

```
attriboo reports sources --site example.com --from 2026-10-01 --to 2026-10-31 --compare none --csv > sources.csv
attriboo reports campaigns --site example.com --period 30d --json > campaigns.json
```

## Approve website setup separately

Default login requests analytics:read. Run attriboo login --setup to request sites:write as well. Only an owner or admin with all-website access can approve it. Existing report-only connections retain their permissions.

Confirm the website details before adding it. The server enforces your current plan, and repeated requests for the same domain reuse the existing website. Setup does not buy an upgrade, change privacy preferences, connect payment accounts or deploy your project.

Add a website and obtain its real script

```
attriboo login --setup
attriboo sites add --domain example.com --currency USD --timezone UTC --confirm
attriboo sites script --site example.com --format html
attriboo sites verify --site example.com
```

- [Choose the matching platform installation guide](https://www.attriboo.com/docs/installation)
- [Give your AI agent the setup prompt](https://www.attriboo.com/agents)

## Check the result before saying setup is finished

Install the returned snippet once using the platform guide and your site's consent choices. Publish the change, make a permitted visit, then run sites verify. It checks received activity and timestamps. It does not inspect your deployed code or verify payments.

Verification returns status waiting when no activity has arrived and paused when collection is paused. These states exit with code 2; ordinary command failures exit with code 1. A successful command exits with code 0. Read the returned timestamps before treating old activity as evidence of a new deployment.

Core reports for larger sites use database totals within the available 365-day history. Sales return next_cursor for another page; pass it with --cursor and the same site and dates. Other detailed reports still use the 250,000-event snapshot guard. Failed reports never show partial totals. Collection allowances and reporting capacity are separate.

## Keep credentials private and disconnect

The CLI saves its rotating OAuth credentials under your user profile: %LOCALAPPDATA%/Attriboo/credentials.json on Windows, or ~/.config/attriboo/credentials.json elsewhere unless XDG_CONFIG_HOME is set. POSIX files use 0600 permissions; Windows inherits your user-profile permissions. Do not copy these files into a project or share them.

Run attriboo logout to revoke the saved session and remove its credentials. If revocation fails, the file remains so you can retry. You can also disconnect the CLI in Settings → API & MCP → Connected AI apps. A privately configured ATTRIBOO_API_KEY environment value is separate and is not removed by logout.

For a remote or CI machine, configure a workspace API key privately for reports. It cannot authorize the new setup endpoints. Never put a key in a command-line flag, public prompt, tracking script or screenshot.

## You are done when

You can read the correct website's reports, export them with clear scope and use only the setup permissions you approved.

## Related guides

- [Get started with your AI agent](https://www.attriboo.com/docs/markdown/agents.md)
- [Read Attriboo reports through the API](https://www.attriboo.com/docs/markdown/api.md)
- [Connect your AI assistant with MCP](https://www.attriboo.com/docs/markdown/mcp.md)
- [Install Attriboo on your website](https://www.attriboo.com/docs/markdown/installation.md)
- [Connect your payment provider](https://www.attriboo.com/docs/markdown/payment-connections.md)