@tokenomist-ai/tokenomist-cli 0.1.0 → 0.1.1

package/README.md

@@ -5,34 +5,43 @@
 
 CLI tool for the [Tokenomist API](https://tokenomist.ai) — query token unlocks, emissions, fundraising, burns, and buybacks from the terminal.
 
-## Quick Start
+## Quick Start (Internal)
+
+```bash
+git clone https://github.com/tokenomist-ai/tokenomist-cli.git
+cd tokenomist-cli
+cp .env.example .env        # then edit .env with your API key and base URL
+npm install
+npm run build
+npm link
+tok auth login
+tok token list
+```
+
+## Installation
 
 ```bash
 npm install -g @tokenomist-ai/tokenomist-cli
-tokenomist auth login
-tokenomist token list
 ```
 
-Or run without installing:
+Or use without installing:
 
 ```bash
 npx @tokenomist-ai/tokenomist-cli token list
 ```
 
-> **Requirements:** Node.js 18+ and a Tokenomist API key — get one at [tokenomist.ai](https://tokenomist.ai).
-
 ## Authentication
 
 Get an API key from [tokenomist.ai](https://tokenomist.ai) and configure it.
 
-### `tokenomist auth login` (recommended)
+### `tok auth login` (recommended)
 
 ```bash
-tokenomist auth login
+tok auth login
 # Enter your Tokenomist API key: ****
 
 # Or pass directly:
-tokenomist auth login --api-key your-api-key
+tok auth login --api-key your-api-key
 ```
 
 This stores your key in `~/.tokenomist/config.json` with restricted file permissions (`0600`).
@@ -40,7 +49,7 @@ This stores your key in `~/.tokenomist/config.json` with restricted file permiss
 ### Check auth status
 
 ```bash
-tokenomist auth status
+tok auth status
 # Source:  ~/.tokenomist/config.json
 # Key:     tk-t****ab2f
 ```
@@ -48,7 +57,7 @@ tokenomist auth status
 ### Remove stored key
 
 ```bash
-tokenomist auth logout
+tok auth logout
 ```
 
 ### Alternative methods
@@ -65,7 +74,7 @@ TOKENOMIST_API_KEY=your-api-key
 
 **CLI flag (per-command)**
 ```bash
-tokenomist token list --api-key your-api-key
+tok token list --api-key your-api-key
 ```
 
 ### Resolution order
@@ -82,6 +91,16 @@ Tokenomist CLI ships with AI coding skills that let agents (Claude Code, Cursor,
 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:
+
+```bash
+npx skills add .
+```
+
+This reads the skill definitions from the local `.agents/skills/` directory instead of fetching from the registry.
+
 ### Available skills
 
 | Skill | Description |
@@ -97,52 +116,52 @@ npx skills add tokenomist-ai/tokenomist-cli
 
 ### Token list
 ```bash
-tokenomist token list
-tokenomist token list --output csv
+tok token list
+tok token list --output csv
 ```
 
 ### Unlock events
 ```bash
-tokenomist unlock list
-tokenomist unlock list --min-market-cap 1000000
-tokenomist unlock upcoming
-tokenomist unlock events solana --start 2024-01-01 --end 2024-12-31
+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
 ```bash
-tokenomist investor list
-tokenomist investor detail <investorId>
-tokenomist investor detail <investorId> --is-lead-investor
+tok investor list
+tok investor detail <investorId>
+tok investor detail <investorId> --is-lead-investor
 ```
 
 ### Fundraising
 ```bash
-tokenomist fundraising solana
-tokenomist fundraising solana --output json
+tok fundraising detail solana
+tok fundraising detail solana --output json
 ```
 
 ### Burns
 ```bash
-tokenomist burn list
-tokenomist burn detail solana --start 2024-01-01
+tok burn list
+tok burn detail solana --start 2024-01-01
 ```
 
 ### Buybacks
 ```bash
-tokenomist buyback list
-tokenomist buyback detail solana
+tok buyback list
+tok buyback detail solana
 ```
 
 ### Emissions
 ```bash
-tokenomist emission daily solana
-tokenomist emission weekly solana --start 2024-01-01 --end 2024-06-30
+tok emission daily solana
+tok emission weekly solana --start 2024-01-01 --end 2024-06-30
 ```
 
 ### Allocations
 ```bash
-tokenomist allocation solana
+tok allocation detail solana
 ```
 
 ## Global Options
@@ -166,11 +185,9 @@ npm test
 
 # Link for local testing
 npm link
-tokenomist --help
+tok --help
 ```
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on filing issues and submitting pull requests.
-
 ## License
 
 [MIT](LICENSE)