@tokenomist-ai/tokenomist-cli 0.1.1 → 0.2.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 +1 -1
- package/README.md +28 -14
- package/dist/chunk-DCGA3ANT.js +84 -0
- package/dist/chunk-DCGA3ANT.js.map +1 -0
- package/dist/index.js +454 -60
- package/dist/index.js.map +1 -1
- package/dist/update-check.js +3 -80
- package/dist/update-check.js.map +1 -1
- package/package.json +2 -2
- package/skills/tokenomist-allocation-breakdown/SKILL.md +2 -1
- package/skills/tokenomist-burn-buyback/SKILL.md +6 -2
- package/skills/tokenomist-emission-report/SKILL.md +4 -0
- package/skills/tokenomist-fundraising-lookup/SKILL.md +4 -0
- package/skills/tokenomist-point-in-time/SKILL.md +95 -0
- package/skills/tokenomist-unlock-analysis/SKILL.md +4 -0
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -5,31 +5,22 @@
|
|
|
5
5
|
|
|
6
6
|
CLI tool for the [Tokenomist API](https://tokenomist.ai) — query token unlocks, emissions, fundraising, burns, and buybacks from the terminal.
|
|
7
7
|
|
|
8
|
-
## Quick Start
|
|
8
|
+
## Quick Start
|
|
9
9
|
|
|
10
10
|
```bash
|
|
11
|
-
|
|
12
|
-
cd tokenomist-cli
|
|
13
|
-
cp .env.example .env # then edit .env with your API key and base URL
|
|
14
|
-
npm install
|
|
15
|
-
npm run build
|
|
16
|
-
npm link
|
|
11
|
+
npm install -g @tokenomist-ai/tokenomist-cli
|
|
17
12
|
tok auth login
|
|
18
13
|
tok token list
|
|
19
14
|
```
|
|
20
15
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
npm install -g @tokenomist-ai/tokenomist-cli
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
Or use without installing:
|
|
16
|
+
Or run without installing:
|
|
28
17
|
|
|
29
18
|
```bash
|
|
30
19
|
npx @tokenomist-ai/tokenomist-cli token list
|
|
31
20
|
```
|
|
32
21
|
|
|
22
|
+
> **Requirements:** Node.js 18+ and a Tokenomist API key — get one at [tokenomist.ai](https://tokenomist.ai).
|
|
23
|
+
|
|
33
24
|
## Authentication
|
|
34
25
|
|
|
35
26
|
Get an API key from [tokenomist.ai](https://tokenomist.ai) and configure it.
|
|
@@ -111,6 +102,7 @@ This reads the skill definitions from the local `.agents/skills/` directory inst
|
|
|
111
102
|
| `tokenomist-fundraising-lookup` | Fundraising rounds, investors, and valuations |
|
|
112
103
|
| `tokenomist-burn-buyback` | Token burn and buyback activity |
|
|
113
104
|
| `tokenomist-allocation-breakdown` | Full allocation distribution for a token |
|
|
105
|
+
| `tokenomist-point-in-time` | Tokenomics as published at a past version (history, audits, backtests) |
|
|
114
106
|
|
|
115
107
|
## Usage
|
|
116
108
|
|
|
@@ -164,6 +156,27 @@ tok emission weekly solana --start 2024-01-01 --end 2024-06-30
|
|
|
164
156
|
tok allocation detail solana
|
|
165
157
|
```
|
|
166
158
|
|
|
159
|
+
### Point-in-time history
|
|
160
|
+
A token's data as it was published at a past version. Select the version with `--as-of` (a date or RFC 3339 instant) or `--version-id` (from `pit versions`), not both; omit both for the current version. Point-in-time answers carry no USD fields. Requires a plan with point-in-time access (API, ELITE or TEAM).
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
tok pit versions arbitrum
|
|
164
|
+
tok pit allocation arbitrum --as-of 2024-01-01
|
|
165
|
+
tok pit daily-emission arbitrum --as-of 2024-01-01 --start 2024-03-01 --end 2024-03-31
|
|
166
|
+
tok pit unlock-events arbitrum --version-id <versionId> --output json
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
With `--output json`, `pit allocation`, `pit daily-emission` and `pit unlock-events` return `{ "asOf", "version", "data", "pagination" }` (`pagination` on the two series commands only); `pit versions` returns `{ "data", "pagination" }`.
|
|
170
|
+
|
|
171
|
+
### Pagination
|
|
172
|
+
Unlock, emission, investor list, burn list, buyback list, `pit versions` and the `pit` series commands return one page (20 rows by default). The page position is printed to **stderr**, so stdout stays clean for `--output json` / `csv`:
|
|
173
|
+
|
|
174
|
+
```
|
|
175
|
+
Page 1/2 · 28 total · next: --page 2 (or raise --page-size)
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
Use `--page` / `--page-size` to get the rest. A page past the last returns the last page again.
|
|
179
|
+
|
|
167
180
|
## Global Options
|
|
168
181
|
|
|
169
182
|
| Option | Description |
|
|
@@ -171,6 +184,7 @@ tok allocation detail solana
|
|
|
171
184
|
| `-k, --api-key <key>` | Override API key |
|
|
172
185
|
| `-o, --output <format>` | Output format: `table` (default), `json`, `csv` |
|
|
173
186
|
| `--base-url <url>` | Override API base URL (default: `https://api.tokenomist.ai`) |
|
|
187
|
+
| `--no-cache` | Bypass the 10-minute response cache |
|
|
174
188
|
| `-V, --version` | Print version |
|
|
175
189
|
| `-h, --help` | Show help |
|
|
176
190
|
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
// package.json
|
|
4
|
+
var package_default = {
|
|
5
|
+
name: "@tokenomist-ai/tokenomist-cli",
|
|
6
|
+
version: "0.2.0",
|
|
7
|
+
description: "CLI tool for the Tokenomist API \u2014 query token unlocks, emissions, fundraising, burns, buybacks, and point-in-time history from the terminal",
|
|
8
|
+
type: "module",
|
|
9
|
+
main: "dist/index.js",
|
|
10
|
+
bin: {
|
|
11
|
+
tok: "dist/index.js"
|
|
12
|
+
},
|
|
13
|
+
scripts: {
|
|
14
|
+
postinstall: "node scripts/postinstall.js",
|
|
15
|
+
build: "tsup",
|
|
16
|
+
dev: "tsup --watch",
|
|
17
|
+
start: "node dist/index.js",
|
|
18
|
+
test: "vitest run",
|
|
19
|
+
"test:watch": "vitest",
|
|
20
|
+
lint: "eslint src/ tests/",
|
|
21
|
+
"lint:fix": "eslint src/ tests/ --fix",
|
|
22
|
+
format: "prettier --write 'src/**/*.ts' 'tests/**/*.ts'",
|
|
23
|
+
"format:check": "prettier --check 'src/**/*.ts' 'tests/**/*.ts'",
|
|
24
|
+
prepublishOnly: "npm run build"
|
|
25
|
+
},
|
|
26
|
+
keywords: [
|
|
27
|
+
"tokenomist",
|
|
28
|
+
"crypto",
|
|
29
|
+
"token",
|
|
30
|
+
"unlock",
|
|
31
|
+
"emission",
|
|
32
|
+
"fundraising",
|
|
33
|
+
"burn",
|
|
34
|
+
"buyback",
|
|
35
|
+
"cli",
|
|
36
|
+
"api"
|
|
37
|
+
],
|
|
38
|
+
author: {
|
|
39
|
+
name: "tokenomist-ai",
|
|
40
|
+
email: "support@tokenomist.ai",
|
|
41
|
+
url: "https://tokenomist.ai"
|
|
42
|
+
},
|
|
43
|
+
license: "MIT",
|
|
44
|
+
repository: {
|
|
45
|
+
type: "git",
|
|
46
|
+
url: "git+https://github.com/tokenomist-ai/tokenomist-cli.git"
|
|
47
|
+
},
|
|
48
|
+
homepage: "https://github.com/tokenomist-ai/tokenomist-cli#readme",
|
|
49
|
+
bugs: {
|
|
50
|
+
url: "https://github.com/tokenomist-ai/tokenomist-cli/issues"
|
|
51
|
+
},
|
|
52
|
+
engines: {
|
|
53
|
+
node: ">=18.0.0"
|
|
54
|
+
},
|
|
55
|
+
publishConfig: {
|
|
56
|
+
access: "public"
|
|
57
|
+
},
|
|
58
|
+
files: [
|
|
59
|
+
"dist",
|
|
60
|
+
"skills/**",
|
|
61
|
+
"scripts/postinstall.js",
|
|
62
|
+
"LICENSE",
|
|
63
|
+
"README.md"
|
|
64
|
+
],
|
|
65
|
+
dependencies: {
|
|
66
|
+
"cli-table3": "^0.6.5",
|
|
67
|
+
commander: "^12.1.0",
|
|
68
|
+
dotenv: "^16.4.7"
|
|
69
|
+
},
|
|
70
|
+
devDependencies: {
|
|
71
|
+
"@types/node": "^22.10.0",
|
|
72
|
+
eslint: "^9.16.0",
|
|
73
|
+
prettier: "^3.4.2",
|
|
74
|
+
tsup: "^8.3.5",
|
|
75
|
+
typescript: "^5.7.2",
|
|
76
|
+
"typescript-eslint": "^8.57.0",
|
|
77
|
+
vitest: "^3.2.4"
|
|
78
|
+
}
|
|
79
|
+
};
|
|
80
|
+
|
|
81
|
+
export {
|
|
82
|
+
package_default
|
|
83
|
+
};
|
|
84
|
+
//# sourceMappingURL=chunk-DCGA3ANT.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../package.json"],"sourcesContent":["{\n \"name\": \"@tokenomist-ai/tokenomist-cli\",\n \"version\": \"0.2.0\",\n \"description\": \"CLI tool for the Tokenomist API — query token unlocks, emissions, fundraising, burns, buybacks, and point-in-time history from the terminal\",\n \"type\": \"module\",\n \"main\": \"dist/index.js\",\n \"bin\": {\n \"tok\": \"dist/index.js\"\n },\n \"scripts\": {\n \"postinstall\": \"node scripts/postinstall.js\",\n \"build\": \"tsup\",\n \"dev\": \"tsup --watch\",\n \"start\": \"node dist/index.js\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"lint\": \"eslint src/ tests/\",\n \"lint:fix\": \"eslint src/ tests/ --fix\",\n \"format\": \"prettier --write 'src/**/*.ts' 'tests/**/*.ts'\",\n \"format:check\": \"prettier --check 'src/**/*.ts' 'tests/**/*.ts'\",\n \"prepublishOnly\": \"npm run build\"\n },\n \"keywords\": [\n \"tokenomist\",\n \"crypto\",\n \"token\",\n \"unlock\",\n \"emission\",\n \"fundraising\",\n \"burn\",\n \"buyback\",\n \"cli\",\n \"api\"\n ],\n \"author\": {\n \"name\": \"tokenomist-ai\",\n \"email\": \"support@tokenomist.ai\",\n \"url\": \"https://tokenomist.ai\"\n },\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"git+https://github.com/tokenomist-ai/tokenomist-cli.git\"\n },\n \"homepage\": \"https://github.com/tokenomist-ai/tokenomist-cli#readme\",\n \"bugs\": {\n \"url\": \"https://github.com/tokenomist-ai/tokenomist-cli/issues\"\n },\n \"engines\": {\n \"node\": \">=18.0.0\"\n },\n \"publishConfig\": {\n \"access\": \"public\"\n },\n \"files\": [\n \"dist\",\n \"skills/**\",\n \"scripts/postinstall.js\",\n \"LICENSE\",\n \"README.md\"\n ],\n \"dependencies\": {\n \"cli-table3\": \"^0.6.5\",\n \"commander\": \"^12.1.0\",\n \"dotenv\": \"^16.4.7\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^22.10.0\",\n \"eslint\": \"^9.16.0\",\n \"prettier\": \"^3.4.2\",\n \"tsup\": \"^8.3.5\",\n \"typescript\": \"^5.7.2\",\n \"typescript-eslint\": \"^8.57.0\",\n \"vitest\": \"^3.2.4\"\n }\n}\n"],"mappings":";;;AAAA;AAAA,EACE,MAAQ;AAAA,EACR,SAAW;AAAA,EACX,aAAe;AAAA,EACf,MAAQ;AAAA,EACR,MAAQ;AAAA,EACR,KAAO;AAAA,IACL,KAAO;AAAA,EACT;AAAA,EACA,SAAW;AAAA,IACT,aAAe;AAAA,IACf,OAAS;AAAA,IACT,KAAO;AAAA,IACP,OAAS;AAAA,IACT,MAAQ;AAAA,IACR,cAAc;AAAA,IACd,MAAQ;AAAA,IACR,YAAY;AAAA,IACZ,QAAU;AAAA,IACV,gBAAgB;AAAA,IAChB,gBAAkB;AAAA,EACpB;AAAA,EACA,UAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAAA,EACA,QAAU;AAAA,IACR,MAAQ;AAAA,IACR,OAAS;AAAA,IACT,KAAO;AAAA,EACT;AAAA,EACA,SAAW;AAAA,EACX,YAAc;AAAA,IACZ,MAAQ;AAAA,IACR,KAAO;AAAA,EACT;AAAA,EACA,UAAY;AAAA,EACZ,MAAQ;AAAA,IACN,KAAO;AAAA,EACT;AAAA,EACA,SAAW;AAAA,IACT,MAAQ;AAAA,EACV;AAAA,EACA,eAAiB;AAAA,IACf,QAAU;AAAA,EACZ;AAAA,EACA,OAAS;AAAA,IACP;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAAA,EACA,cAAgB;AAAA,IACd,cAAc;AAAA,IACd,WAAa;AAAA,IACb,QAAU;AAAA,EACZ;AAAA,EACA,iBAAmB;AAAA,IACjB,eAAe;AAAA,IACf,QAAU;AAAA,IACV,UAAY;AAAA,IACZ,MAAQ;AAAA,IACR,YAAc;AAAA,IACd,qBAAqB;AAAA,IACrB,QAAU;AAAA,EACZ;AACF;","names":[]}
|