Skip to main content

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.

Requires Node.js 18+ and a Tokenomist API key. Get one at tokenomist.ai.

Installation

Authentication

1

Get your API key

  1. Sign up or log in at tokenomist.ai
  2. Navigate to the API section of your dashboard
  3. Generate a new API key and copy it
2

Log in

tok auth login
# Enter your Tokenomist API key: ****
Your key is stored in ~/.tokenomist/config.json with restricted file permissions (0600).
3

Verify

tok auth status
# Source:  ~/.tokenomist/config.json
# Key:    tk-t****ab2f

Run Your First Command

tok token list --token-id ethena,solana
You should see a formatted table with market data, supply, and unlock information:
+--------+--------+--------+----------------+------------------+------------------+------------------+----------------------+
| ID     | Name   | Symbol |     Market Cap |     Circ. Supply |           Locked |         Unlocked | Updated              |
+--------+--------+--------+----------------+------------------+------------------+------------------+----------------------+
| ethena | Ethena | ENA    |    976,183,624 |    8,759,375,000 |    4,928,125,000 |    8,048,437,500 | 2025-09-17T05:49:03Z |
| solana | Solana | SOL    | 49,279,843,463 | 575,499,265.8197 | 142,169,244.1616 | 644,999,130.1059 | 2025-08-07T08:37:39Z |
+--------+--------+--------+----------------+------------------+------------------+------------------+----------------------+

AI Skills

Install 6 pre-built skills for Claude Code, Cursor, Windsurf, and other AI agents that can run shell commands.
npx skills add tokenomist-ai/tokenomist-cli
SkillWhat it does
tokenomist-token-overviewBrowse tokens, compare market caps
tokenomist-allocation-breakdownSupply distribution across stakeholders
tokenomist-unlock-analysisAnalyze unlock schedules and impact
tokenomist-emission-reportDaily/weekly emission breakdowns
tokenomist-burn-buybackBurn and buyback activity
tokenomist-fundraising-lookupFunding rounds, investors, valuations
Once installed, your AI agent can query tokenomics data directly — just ask it to “check Solana’s upcoming unlocks” or “compare Arbitrum’s emissions this month.”

Authentication Methods

The CLI resolves your API key in this order (first match wins):
PriorityMethodExample
1--api-key flagtok token list --api-key tk-...
2TOKENOMIST_API_KEY env varexport TOKENOMIST_API_KEY=tk-...
3Config file~/.tokenomist/config.json (set by auth login)
Use auth login for day-to-day work. Use env vars for CI/CD pipelines and Docker containers. Use the --api-key flag for one-off commands or testing with a different key.

Environment variable

export TOKENOMIST_API_KEY=tk-your-api-key
tok token list

.env file

Create a .env file in your project directory:
TOKENOMIST_API_KEY=tk-your-api-key

Output Formats

Every command supports three output formats via the -o / --output flag:
Human-readable formatted table with colored headers and right-aligned numbers.
tok token list

Caching

The CLI caches API responses for 10 minutes to reduce redundant requests and speed up repeated queries. Cache files are stored in ~/.tokenomist/cache/. To bypass the cache and fetch fresh data:
tok token list --no-cache

Uninstalling

npm uninstall -g tokenomist-cli
To also remove stored credentials and cache, run rm -rf ~/.tokenomist. This cannot be undone.