> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tokenomist.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> A fast, full-featured terminal interface for token economics data — designed for developers, analysts, and AI agents.

<Info>
  The Tokenomist CLI is currently in **beta** (v0.1.0). Commands and output formats may change in future releases.
</Info>

The **Tokenomist CLI** (`tok`) gives you direct access to the [Tokenomist API](https://tokenomist.ai/pricing) from your terminal. Query token unlocks, emissions, fundraising rounds, burns, buybacks, and supply allocations — all without leaving your workflow.

## Get Started

<Steps>
  <Step title="Get an API key">
    Sign up or log in at [tokenomist.ai](https://tokenomist.ai) and generate an API key from your [dashboard.](https://tokenomist.ai/profile#my-api-key)
  </Step>

  <Step title="Install the CLI">
    ```bash theme={null}
    npm install -g @tokenomist-ai/tokenomist-cli
    ```
  </Step>

  <Step title="Authenticate">
    ```bash theme={null}
    tok auth login
    ```
  </Step>
</Steps>

## Features at a Glance

<CardGroup cols={2}>
  <Card title="Token Unlock Schedules" icon="lock-open">
    Track upcoming and historical unlock events across 300+ tokens.
  </Card>

  <Card title="Emission Breakdowns" icon="signal-bars">
    Daily and weekly emission data with allocation-level granularity.
  </Card>

  <Card title="Fundraising Intel" icon="magnifying-glass-dollar">
    Funding rounds, lead investors, valuations, and raise amounts.
  </Card>

  <Card title="Burns & Buybacks" icon="fire">
    Deflationary mechanism tracking — burns, buybacks, and net supply changes.
  </Card>

  <Card title="Supply Allocations" icon="chart-pie-simple">
    Full distribution breakdown: team, investors, community, reserves.
  </Card>

  <Card title="Investor Research" icon="user">
    Browse investor portfolios and filter by funding activity.
  </Card>

  <Card title="Multiple Output Formats" icon="code">
    `table`, `json`, and `csv` — pipe data anywhere.
  </Card>

  <Card title="AI Agent Integration" icon="sparkles">
    Pre-built skills for Claude Code, Cursor, Windsurf, and other AI agents.
  </Card>
</CardGroup>

## Common Use Cases

<AccordionGroup>
  <Accordion title="For Developers">
    * Pipe JSON output to scripts and CI/CD pipelines with `-o json`
    * Export data as CSV for downstream processing with `-o csv`
    * Use `tok schema` for machine-readable command discovery
    * Automatic retry with exponential backoff on transient failures

    ```bash theme={null}
    # Get unlock events as JSON for scripting
    tok unlock events solana -o json | jq '.[] | .cliffValue'

    # Export daily emissions to CSV
    tok emission daily arbitrum -o csv > arbitrum-emissions.csv
    ```
  </Accordion>

  <Accordion title="For AI Agents">
    * Install 6 pre-built skills with `npx skills add tokenomist-ai/tokenomist-cli`
    * Structured JSON output ready for LLM consumption via `-o json`
    * Self-documenting — `tok schema` exposes the full command tree
    * Works with Claude Code, Cursor, Windsurf, and any agent that runs shell commands

    ```bash theme={null}
    # Install AI skills
    npx skills add tokenomist-ai/tokenomist-cli

    # Get structured data for LLM analysis
    tok fundraising detail solana -o json
    ```
  </Accordion>

  <Accordion title="For Analysts">
    * Formatted tables for quick terminal lookups
    * Filter unlocks by market cap, date range, allocation type, or value-to-market-cap ratio
    * Export any dataset to CSV for Excel or Google Sheets
    * Built-in 10-minute cache for fast repeated queries

    ```bash theme={null}
    # Find large upcoming unlocks
    tok unlock upcoming --min-value-to-market-cap 0.01

    # Compare allocations across tokens
    tok allocation detail solana -o csv > solana.csv
    tok allocation detail arbitrum -o csv > arbitrum.csv
    ```
  </Accordion>
</AccordionGroup>

## Quick Examples

```bash theme={null}
# List all tracked tokens
tok token list

# Find upcoming unlocks worth >1% of market cap
tok unlock upcoming --min-value-to-market-cap 0.01

# Get daily emissions for Arbitrum this month
tok emission daily arbitrum --start 2024-08-01 --end 2024-08-31

# Export fundraising data as CSV
tok fundraising detail uniswap --output csv > uniswap-fundraising.csv

# Check who invested in a token
tok fundraising detail solana --output json
```

## What's Next

<CardGroup cols={2}>
  <Card title="Getting Started" icon="rocket" href="/cli/getting-started">
    Install, authenticate, and run your first command.
  </Card>

  <Card title="Command Reference" icon="book" href="/cli/command-reference">
    Every command, option, and flag — with examples.
  </Card>
</CardGroup>