Skip to content

tokenomist-ai/tokenomist-cli

Repository files navigation

tokenomist-cli

npm version License: MIT

CLI tool for the Tokenomist API — query token unlocks, emissions, fundraising, burns, and buybacks from the terminal.

Quick Start

npm install -g @tokenomist-ai/tokenomist-cli
tok auth login
tok token list

Or run without installing:

npx @tokenomist-ai/tokenomist-cli token list

Requirements: Node.js 18+ and a Tokenomist API key — get one at tokenomist.ai.

Authentication

Get an API key from tokenomist.ai and configure it.

tok auth login (recommended)

tok auth login
# Enter your Tokenomist API key: ****

# Or pass directly:
tok auth login --api-key your-api-key

This stores your key in ~/.tokenomist/config.json with restricted file permissions (0600).

Check auth status

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

Remove stored key

tok auth logout

Alternative methods

Environment variable

export TOKENOMIST_API_KEY=your-api-key

.env file in project directory

TOKENOMIST_API_KEY=your-api-key

CLI flag (per-command)

tok token list --api-key your-api-key

Resolution order

--api-key flag > TOKENOMIST_API_KEY env var > ~/.tokenomist/config.json

AI Skills

Tokenomist CLI ships with AI coding skills that let agents (Claude Code, Cursor, Windsurf, etc.) query tokenomics data on your behalf.

Install skills

npx skills add tokenomist-ai/tokenomist-cli

Install skills locally (after cloning)

If you've cloned the repo for development, install skills from your local copy:

npx skills add .

This reads the skill definitions from the local .agents/skills/ directory instead of fetching from the registry.

Available skills

Skill Description
tokenomist-token-overview Browse all tracked tokens with market data
tokenomist-unlock-analysis Analyze upcoming and historical token unlocks
tokenomist-emission-report Daily/weekly emission data with allocation breakdowns
tokenomist-fundraising-lookup Fundraising rounds, investors, and valuations
tokenomist-burn-buyback Token burn and buyback activity
tokenomist-allocation-breakdown Full allocation distribution for a token

Usage

Token list

tok token list
tok token list --output csv

Unlock events

tok unlock list
tok unlock list --min-market-cap 1000000
tok unlock upcoming
tok unlock events solana --start 2024-01-01 --end 2024-12-31

Investors

tok investor list
tok investor detail <investorId>
tok investor detail <investorId> --is-lead-investor

Fundraising

tok fundraising detail solana
tok fundraising detail solana --output json

Burns

tok burn list
tok burn detail solana --start 2024-01-01

Buybacks

tok buyback list
tok buyback detail solana

Emissions

tok emission daily solana
tok emission weekly solana --start 2024-01-01 --end 2024-06-30

Allocations

tok allocation detail solana

Global Options

Option Description
-k, --api-key <key> Override API key
-o, --output <format> Output format: table (default), json, csv
--base-url <url> Override API base URL (default: https://api.tokenomist.ai)
-V, --version Print version
-h, --help Show help

Development

git clone https://github.com/tokenomist-ai/tokenomist-cli.git
cd tokenomist-cli
npm install
npm run build
npm test

# Link for local testing
npm link
tok --help

License

MIT

About

CLI and AI agent skills for the Tokenomist crypto data API: token unlocks, vesting, emissions, allocations, fundraising, burns and buybacks.

Topics

Resources

License

Contributing

Stars

23 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors