@evatick/skill 0.4.0 → 0.4.2

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/README.md CHANGED
@@ -1,10 +1,13 @@
1
- # EVA Skill for Codex
1
+ # EVA Tick Skill for Codex
2
2
 
3
- This package installs the EVA Codex Skill, which teaches Codex how to select and
4
- use the locally installed `eva` CLI safely and predictably.
3
+ Teach Codex how to discover financial instruments and query market data through
4
+ the EVA Tick CLI safely and predictably.
5
5
 
6
- The Skill package depends on the matching EVA CLI version, so one npm command
7
- installs both the `eva` command and the Skill installer:
6
+ The package installs the EVA Tick Skill and depends on the exact matching
7
+ version of `@evatick/cli`, so one npm command installs both the `eva` command and
8
+ the Skill installer.
9
+
10
+ ## Install
8
11
 
9
12
  ```shell
10
13
  npm install --global @evatick/skill
@@ -12,15 +15,69 @@ eva-skill install
12
15
  eva-skill status
13
16
  ```
14
17
 
15
- Restart Codex after installing or updating a Skill so it can rediscover the
16
- instructions. To update an existing installation while preserving a recoverable
17
- backup:
18
+ Restart Codex after installing or updating the Skill so it can rediscover the
19
+ instructions.
20
+
21
+ ## Try it in Codex
22
+
23
+ Ask Codex:
24
+
25
+ - “搜索平安银行并告诉我它的规范金融标的 ID。”
26
+ - “查询平安银行最近三个交易日的前复权日线。”
27
+ - “检查 000001 是股票还是指数。”
28
+ - “查询沪深 300 的指数成分并导出 CSV。”
29
+ - “分别查询 Binance 和 Coinbase 的 BTC-USDT 行情,不要混用交易所。”
30
+
31
+ The Skill helps Codex select and sequence the appropriate `eva` commands from a
32
+ natural-language request.
33
+
34
+ ## What the Skill does
35
+
36
+ The Skill instructs Codex to:
37
+
38
+ 1. Check the locally installed CLI and the configured EVA Tick service.
39
+ 2. Search or resolve uncertain instrument input before requesting data.
40
+ 3. Prefer canonical instrument IDs when a name or trading code is ambiguous.
41
+ 4. Inspect leaf-command help before unfamiliar calls.
42
+ 5. Parse stdout as one strict JSON value and handle structured errors.
43
+ 6. Report the requested instrument, period, and known data limitations.
44
+
45
+ The Skill teaches Codex how to use the CLI; the EVA Tick Server owns provider
46
+ routing, fallback, retries, normalization, and catalog persistence.
47
+
48
+ ## Safety and data boundaries
49
+
50
+ - Never exposes API keys from environment variables or configuration files.
51
+ - Never adds `--overwrite` without user authorization.
52
+ - Does not call upstream data providers directly when EVA Tick fails.
53
+ - Does not invent unsupported commands, markets, or asset capabilities.
54
+ - Treats market data as research and reference material, not investment advice.
55
+
56
+ The current service contract covers mainland China A-shares, Chinese indices,
57
+ official CFFEX, SHFE, INE, and CZCE futures, and exchange-scoped Binance and
58
+ Coinbase cryptocurrency market data. Futures support unadjusted daily bars.
59
+ Cryptocurrency commands require an explicit venue. Availability depends on the
60
+ configured service and its enabled providers.
61
+
62
+ ## Update
18
63
 
19
64
  ```shell
20
65
  npm update --global @evatick/skill
21
66
  eva-skill update
67
+ eva-skill status
22
68
  ```
23
69
 
24
- `eva-skill` installs into `$CODEX_HOME/skills/eva`, or `~/.codex/skills/eva`
25
- when `CODEX_HOME` is unset. It does not use npm lifecycle scripts and never
26
- silently overwrites an existing Skill.
70
+ `eva-skill update` replaces the installed Skill and preserves the previous copy
71
+ as a recoverable backup. Automated removal of the copied Skill is not currently
72
+ provided.
73
+
74
+ The Skill is installed into `$CODEX_HOME/skills/eva`, or
75
+ `~/.codex/skills/eva` when `CODEX_HOME` is unset. It does not use npm lifecycle
76
+ scripts and never silently overwrites an existing Skill.
77
+
78
+ ## Documentation
79
+
80
+ - [EVA Tick Skill source](https://github.com/xiaochaohit/evatick-cli/tree/main/skills/eva)
81
+ - [Complete command guide](https://github.com/xiaochaohit/evatick-cli/blob/main/skills/eva/references/command-guide.md)
82
+ - [EVA Tick CLI documentation](https://github.com/xiaochaohit/evatick-cli#readme)
83
+ - [EVA Tick Server and OpenAPI](https://github.com/xiaochaohit/evatick-server)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@evatick/skill",
3
- "version": "0.4.0",
4
- "description": "Codex Skill for using the EVA market data CLI",
3
+ "version": "0.4.2",
4
+ "description": "Codex Skill for discovering instruments and querying financial data through the EVA Tick CLI",
5
5
  "license": "MIT",
6
6
  "repository": {
7
7
  "type": "git",
@@ -22,8 +22,18 @@
22
22
  "engines": {
23
23
  "node": ">=18"
24
24
  },
25
+ "keywords": [
26
+ "eva-tick",
27
+ "codex",
28
+ "codex-skill",
29
+ "agent-skill",
30
+ "ai-agent",
31
+ "financial-data",
32
+ "market-data",
33
+ "automation"
34
+ ],
25
35
  "dependencies": {
26
- "@evatick/cli": "0.4.0"
36
+ "@evatick/cli": "0.4.2"
27
37
  },
28
38
  "publishConfig": {
29
39
  "access": "public"
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: eva
3
- description: Query and export mainland A-share and Chinese index data through the locally installed EVA CLI and EVA service. Use for instrument listing, search, resolution and inspection; stock and index quotes or bars; index constituents; EVA service health checks; and EVA CLI HTTP or authentication troubleshooting.
3
+ description: Query and export mainland A-share, Chinese index, mainland futures, and exchange-scoped cryptocurrency data through the locally installed EVA CLI and EVA service. Use for instrument discovery; stock, index, futures, or crypto quotes and bars; index constituents; service health checks; and CLI HTTP or authentication troubleshooting.
4
4
  ---
5
5
 
6
6
  # Use EVA
@@ -25,12 +25,13 @@ v1 command tree, output options, configuration, and error handling.
25
25
 
26
26
  - Use named options only.
27
27
  - Prefer canonical instrument IDs when a symbol or name is ambiguous.
28
+ - For cryptocurrency queries, always pass `--venue BINANCE` or `--venue COINBASE`; never combine or substitute prices across venues.
28
29
  - Use ISO dates such as `2026-08-15` for `--start`, `--end`, and `--as-of`.
29
30
  - Use `--output PATH` for large results. Add `--format` only to select `json`, `jsonl`, `csv`, or `parquet`.
30
31
  - Do not add `--overwrite` without user authorization.
31
32
  - Never expose API keys from environment variables or configuration files.
32
33
  - Let the EVA service handle provider routing. Report retryable service failures instead of calling providers directly.
33
- - Do not invent unsupported commands for funds, futures, options, bonds, FX, macro data, calendars, or alternative data.
34
+ - Futures support unadjusted daily bars from CFFEX, SHFE, INE, and CZCE. Do not invent unsupported commands for funds, options, bonds, FX, macro data, calendars, or alternative data.
34
35
 
35
36
  ## Quick sequence
36
37
 
@@ -39,4 +40,5 @@ eva health
39
40
  eva instrument search --query 平安银行 --type equity
40
41
  eva stock bars --help
41
42
  eva stock bars --symbol 000001 --start 2026-08-01 --end 2026-08-15 --limit 20
43
+ eva crypto quotes --symbol BTC-USDT --venue BINANCE
42
44
  ```
@@ -1,4 +1,4 @@
1
1
  interface:
2
2
  display_name: "EVA"
3
- short_description: "通过 EVA CLI 查询、解析并导出中国股票和指数数据"
3
+ short_description: "通过 EVA CLI 查询并导出股票、指数、期货和交易所加密货币数据"
4
4
  default_prompt: "Use $eva to find and run the right EVA market data command."
@@ -26,21 +26,32 @@ eva health
26
26
  eva version
27
27
  eva config set|show
28
28
 
29
- eva instrument list [--type equity|index] [--venue VENUE] [--publisher PUBLISHER]
30
- eva instrument search --query TEXT [--type equity|index]
31
- eva instrument resolve --query TEXT [--type equity|index]
29
+ eva instrument list [--type equity|index|future|crypto] [--venue VENUE] [--publisher PUBLISHER]
30
+ eva instrument search --query TEXT [--type equity|index|future|crypto] [--venue VENUE]
31
+ eva instrument resolve --query TEXT [--type equity|index|future|crypto] [--venue VENUE]
32
32
  eva instrument show --id CANONICAL_ID
33
33
 
34
34
  eva stock quotes --symbol SYMBOL_OR_ID
35
- eva stock bars --symbol SYMBOL_OR_ID [--interval INTERVAL] [--start DATE] [--end DATE]
35
+ eva stock bars --symbol SYMBOL_OR_ID [--interval INTERVAL] [--start DATE] [--end DATE] [--adjustment none|forward|backward] [--as-of DATE]
36
36
 
37
37
  eva index quotes --symbol SYMBOL_OR_ID
38
38
  eva index bars --symbol SYMBOL_OR_ID [--interval INTERVAL] [--start DATE] [--end DATE]
39
39
  eva index constituents --symbol SYMBOL_OR_ID [--as-of DATE]
40
+
41
+ eva futures quotes --symbol SYMBOL_OR_ID
42
+ eva futures bars --symbol SYMBOL_OR_ID [--interval 1d] [--start DATE] [--end DATE]
43
+
44
+ eva crypto quotes --symbol SYMBOL_OR_ID --venue BINANCE|COINBASE
45
+ eva crypto bars --symbol SYMBOL_OR_ID --venue BINANCE|COINBASE [--interval INTERVAL] [--start DATE] [--end DATE]
40
46
  ```
41
47
 
42
48
  Supported bar intervals are `1m`, `5m`, `15m`, `30m`, `60m`, `1d`, `1w`, and
43
- `1mo`. Inspect leaf help for context and adjustment options.
49
+ `1mo`. Stock bars can be forward- or backward-adjusted. `--as-of` selects the
50
+ forward-adjustment anchor date; indices and cryptocurrencies only support
51
+ unadjusted bars. Coinbase supports `1m`, `5m`, `15m`, `60m`, and `1d`; Binance
52
+ supports every listed interval. Cryptocurrency commands require an exchange
53
+ venue and never fall back to the other exchange. Chinese futures use official
54
+ CFFEX, SHFE, INE, and CZCE sources and support unadjusted daily bars.
44
55
 
45
56
  ## Results and files
46
57