@tokenomist-ai/tokenomist-cli 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 tokenomist-ai contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,176 @@
1
+ # tokenomist-cli
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@tokenomist-ai/tokenomist-cli.svg)](https://www.npmjs.com/package/@tokenomist-ai/tokenomist-cli)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+
6
+ CLI tool for the [Tokenomist API](https://tokenomist.ai) — query token unlocks, emissions, fundraising, burns, and buybacks from the terminal.
7
+
8
+ ## Quick Start
9
+
10
+ ```bash
11
+ npm install -g @tokenomist-ai/tokenomist-cli
12
+ tokenomist auth login
13
+ tokenomist token list
14
+ ```
15
+
16
+ Or run without installing:
17
+
18
+ ```bash
19
+ npx @tokenomist-ai/tokenomist-cli token list
20
+ ```
21
+
22
+ > **Requirements:** Node.js 18+ and a Tokenomist API key — get one at [tokenomist.ai](https://tokenomist.ai).
23
+
24
+ ## Authentication
25
+
26
+ Get an API key from [tokenomist.ai](https://tokenomist.ai) and configure it.
27
+
28
+ ### `tokenomist auth login` (recommended)
29
+
30
+ ```bash
31
+ tokenomist auth login
32
+ # Enter your Tokenomist API key: ****
33
+
34
+ # Or pass directly:
35
+ tokenomist auth login --api-key your-api-key
36
+ ```
37
+
38
+ This stores your key in `~/.tokenomist/config.json` with restricted file permissions (`0600`).
39
+
40
+ ### Check auth status
41
+
42
+ ```bash
43
+ tokenomist auth status
44
+ # Source: ~/.tokenomist/config.json
45
+ # Key: tk-t****ab2f
46
+ ```
47
+
48
+ ### Remove stored key
49
+
50
+ ```bash
51
+ tokenomist auth logout
52
+ ```
53
+
54
+ ### Alternative methods
55
+
56
+ **Environment variable**
57
+ ```bash
58
+ export TOKENOMIST_API_KEY=your-api-key
59
+ ```
60
+
61
+ **`.env` file in project directory**
62
+ ```
63
+ TOKENOMIST_API_KEY=your-api-key
64
+ ```
65
+
66
+ **CLI flag (per-command)**
67
+ ```bash
68
+ tokenomist token list --api-key your-api-key
69
+ ```
70
+
71
+ ### Resolution order
72
+
73
+ `--api-key` flag > `TOKENOMIST_API_KEY` env var > `~/.tokenomist/config.json`
74
+
75
+ ## AI Skills
76
+
77
+ Tokenomist CLI ships with AI coding skills that let agents (Claude Code, Cursor, Windsurf, etc.) query tokenomics data on your behalf.
78
+
79
+ ### Install skills
80
+
81
+ ```bash
82
+ npx skills add tokenomist-ai/tokenomist-cli
83
+ ```
84
+
85
+ ### Available skills
86
+
87
+ | Skill | Description |
88
+ |-------|-------------|
89
+ | `tokenomist-token-overview` | Browse all tracked tokens with market data |
90
+ | `tokenomist-unlock-analysis` | Analyze upcoming and historical token unlocks |
91
+ | `tokenomist-emission-report` | Daily/weekly emission data with allocation breakdowns |
92
+ | `tokenomist-fundraising-lookup` | Fundraising rounds, investors, and valuations |
93
+ | `tokenomist-burn-buyback` | Token burn and buyback activity |
94
+ | `tokenomist-allocation-breakdown` | Full allocation distribution for a token |
95
+
96
+ ## Usage
97
+
98
+ ### Token list
99
+ ```bash
100
+ tokenomist token list
101
+ tokenomist token list --output csv
102
+ ```
103
+
104
+ ### Unlock events
105
+ ```bash
106
+ tokenomist unlock list
107
+ tokenomist unlock list --min-market-cap 1000000
108
+ tokenomist unlock upcoming
109
+ tokenomist unlock events solana --start 2024-01-01 --end 2024-12-31
110
+ ```
111
+
112
+ ### Investors
113
+ ```bash
114
+ tokenomist investor list
115
+ tokenomist investor detail <investorId>
116
+ tokenomist investor detail <investorId> --is-lead-investor
117
+ ```
118
+
119
+ ### Fundraising
120
+ ```bash
121
+ tokenomist fundraising solana
122
+ tokenomist fundraising solana --output json
123
+ ```
124
+
125
+ ### Burns
126
+ ```bash
127
+ tokenomist burn list
128
+ tokenomist burn detail solana --start 2024-01-01
129
+ ```
130
+
131
+ ### Buybacks
132
+ ```bash
133
+ tokenomist buyback list
134
+ tokenomist buyback detail solana
135
+ ```
136
+
137
+ ### Emissions
138
+ ```bash
139
+ tokenomist emission daily solana
140
+ tokenomist emission weekly solana --start 2024-01-01 --end 2024-06-30
141
+ ```
142
+
143
+ ### Allocations
144
+ ```bash
145
+ tokenomist allocation solana
146
+ ```
147
+
148
+ ## Global Options
149
+
150
+ | Option | Description |
151
+ |--------|-------------|
152
+ | `-k, --api-key <key>` | Override API key |
153
+ | `-o, --output <format>` | Output format: `table` (default), `json`, `csv` |
154
+ | `--base-url <url>` | Override API base URL (default: `https://api.tokenomist.ai`) |
155
+ | `-V, --version` | Print version |
156
+ | `-h, --help` | Show help |
157
+
158
+ ## Development
159
+
160
+ ```bash
161
+ git clone https://github.com/tokenomist-ai/tokenomist-cli.git
162
+ cd tokenomist-cli
163
+ npm install
164
+ npm run build
165
+ npm test
166
+
167
+ # Link for local testing
168
+ npm link
169
+ tokenomist --help
170
+ ```
171
+
172
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on filing issues and submitting pull requests.
173
+
174
+ ## License
175
+
176
+ [MIT](LICENSE)