@evatick/cli 0.4.0 → 0.4.1

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.
Files changed (2) hide show
  1. package/README.md +80 -10
  2. package/package.json +17 -3
package/README.md CHANGED
@@ -1,7 +1,13 @@
1
- # EVA CLI
1
+ # EVA Tick CLI
2
2
 
3
- EVA CLI is a stable, machine-readable market-data command-line client for LLMs,
4
- AI agents, and automation. It connects to the versioned EVA HTTP API.
3
+ Deterministic, machine-readable financial data for AI agents, LLMs, and
4
+ automation.
5
+
6
+ EVA Tick gives agents canonical instrument IDs, stable JSON, structured errors,
7
+ and predictable commands instead of provider-specific identifiers and
8
+ functions.
9
+
10
+ ![Codex queries financial data through EVA Tick](https://raw.githubusercontent.com/xiaochaohit/evatick-cli/main/docs/assets/eva-tick-codex-demo.gif)
5
11
 
6
12
  ## Install
7
13
 
@@ -10,17 +16,81 @@ npm install --global @evatick/cli
10
16
  eva version
11
17
  ```
12
18
 
13
- It can also be run without a global installation:
19
+ Run it without installing:
14
20
 
15
21
  ```shell
16
22
  npx @evatick/cli health
17
23
  ```
18
24
 
19
- The npm package is implemented in Node.js and has no runtime dependencies.
20
- Python and platform-specific native executables are not required.
25
+ The npm package is implemented in Node.js, has no runtime dependencies, and
26
+ does not require Python or platform-specific native executables.
27
+
28
+ ## First query
29
+
30
+ ```shell
31
+ eva health
32
+ eva instrument search --query 平安银行 --type equity --limit 3
33
+ eva instrument resolve --query 000001 --type equity
34
+ eva stock bars --symbol cn:equity:XSHE:000001 \
35
+ --interval 1d \
36
+ --start 2026-08-18 \
37
+ --end 2026-08-21 \
38
+ --adjustment forward \
39
+ --limit 3
40
+ ```
41
+
42
+ ## Common commands
43
+
44
+ - `eva instrument search` finds canonical financial instruments by name, code,
45
+ or alias.
46
+ - `eva stock bars` queries normalized OHLCV bars.
47
+ - `eva index constituents` queries index constituent memberships.
48
+
49
+ Run `eva COMMAND --help` or `eva GROUP COMMAND --help` for supported options.
50
+
51
+ ## Hosted or self-hosted
52
+
53
+ The CLI connects to the hosted EVA Tick service at `https://api.evatick.com` by
54
+ default. Point it at a self-hosted [EVA Tick Server](https://github.com/xiaochaohit/evatick-server)
55
+ temporarily with an environment variable:
56
+
57
+ ```shell
58
+ EVA_SERVER_URL=http://127.0.0.1:8765 eva health
59
+ ```
60
+
61
+ Or save the service URL:
62
+
63
+ ```shell
64
+ eva config set --base-url http://127.0.0.1:8765
65
+ eva config show
66
+ ```
67
+
68
+ When a service requires authentication, use `EVA_API_KEY` or
69
+ `eva config set --api-key 'eva_...'`. The CLI sends a key only when configured,
70
+ and `eva config show` masks stored keys.
71
+
72
+ ## Current availability
73
+
74
+ EVA Tick is designed as a provider-independent financial data layer. The
75
+ current public service starts with mainland China A-shares and indices published
76
+ by the Shanghai Stock Exchange, Shenzhen Stock Exchange, and China Securities
77
+ Index. Availability varies by deployed service and enabled providers.
78
+
79
+ ## Output and safety
80
+
81
+ - Successful results are compact JSON on stdout.
82
+ - Failures are structured JSON on stderr with stable error codes.
83
+ - JSON, JSONL, and CSV file exports are supported by the npm CLI.
84
+ - Existing files are never overwritten unless `--overwrite` is explicit.
85
+ - Parquet export is available in the Python distribution with
86
+ `pip install 'evatick[parquet]'`.
87
+
88
+ ## Documentation
21
89
 
22
- JSON, JSONL, and CSV exports are supported. Parquet export remains available in
23
- the Python distribution (`pip install 'evatick[parquet]'`).
90
+ - [Complete CLI documentation and examples](https://github.com/xiaochaohit/evatick-cli#readme)
91
+ - [EVA Tick Skill for Codex](https://www.npmjs.com/package/@evatick/skill)
92
+ - [Self-hosted server and OpenAPI contract](https://github.com/xiaochaohit/evatick-server)
93
+ - [License and data-source notices](https://github.com/xiaochaohit/evatick-cli#license)
24
94
 
25
- See the [EVA CLI repository](https://github.com/xiaochaohit/evatick-cli) for
26
- commands, configuration, source code, and license information.
95
+ Market data is provided for research and reference only and does not constitute
96
+ investment advice.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@evatick/cli",
3
- "version": "0.4.0",
4
- "description": "EVA market data command-line client for LLMs, agents, and automation",
3
+ "version": "0.4.1",
4
+ "description": "EVA Tick CLI for deterministic, machine-readable financial data queries by AI agents, LLMs, and automation",
5
5
  "license": "MIT",
6
6
  "repository": {
7
7
  "type": "git",
@@ -23,5 +23,19 @@
23
23
  ],
24
24
  "engines": {
25
25
  "node": ">=18"
26
- }
26
+ },
27
+ "keywords": [
28
+ "eva-tick",
29
+ "financial-data",
30
+ "market-data",
31
+ "ai-agent",
32
+ "llm",
33
+ "codex",
34
+ "automation",
35
+ "quantitative-finance",
36
+ "openapi",
37
+ "akshare",
38
+ "a-share",
39
+ "china-stock-market"
40
+ ]
27
41
  }