@evatick/skill 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 +65 -11
  2. package/package.json +13 -3
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,66 @@ 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
+
30
+ The Skill helps Codex select and sequence the appropriate `eva` commands from a
31
+ natural-language request.
32
+
33
+ ## What the Skill does
34
+
35
+ The Skill instructs Codex to:
36
+
37
+ 1. Check the locally installed CLI and the configured EVA Tick service.
38
+ 2. Search or resolve uncertain instrument input before requesting data.
39
+ 3. Prefer canonical instrument IDs when a name or trading code is ambiguous.
40
+ 4. Inspect leaf-command help before unfamiliar calls.
41
+ 5. Parse stdout as one strict JSON value and handle structured errors.
42
+ 6. Report the requested instrument, period, and known data limitations.
43
+
44
+ The Skill teaches Codex how to use the CLI; the EVA Tick Server owns provider
45
+ routing, fallback, retries, normalization, and catalog persistence.
46
+
47
+ ## Safety and data boundaries
48
+
49
+ - Never exposes API keys from environment variables or configuration files.
50
+ - Never adds `--overwrite` without user authorization.
51
+ - Does not call upstream data providers directly when EVA Tick fails.
52
+ - Does not invent unsupported commands, markets, or asset capabilities.
53
+ - Treats market data as research and reference material, not investment advice.
54
+
55
+ The current public service starts with mainland China A-shares and Chinese
56
+ indices. Availability depends on the configured service and its enabled
57
+ providers.
58
+
59
+ ## Update
18
60
 
19
61
  ```shell
20
62
  npm update --global @evatick/skill
21
63
  eva-skill update
64
+ eva-skill status
22
65
  ```
23
66
 
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.
67
+ `eva-skill update` replaces the installed Skill and preserves the previous copy
68
+ as a recoverable backup. Automated removal of the copied Skill is not currently
69
+ provided.
70
+
71
+ The Skill is installed into `$CODEX_HOME/skills/eva`, or
72
+ `~/.codex/skills/eva` when `CODEX_HOME` is unset. It does not use npm lifecycle
73
+ scripts and never silently overwrites an existing Skill.
74
+
75
+ ## Documentation
76
+
77
+ - [EVA Tick Skill source](https://github.com/xiaochaohit/evatick-cli/tree/main/skills/eva)
78
+ - [Complete command guide](https://github.com/xiaochaohit/evatick-cli/blob/main/skills/eva/references/command-guide.md)
79
+ - [EVA Tick CLI documentation](https://github.com/xiaochaohit/evatick-cli#readme)
80
+ - [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.1",
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.1"
27
37
  },
28
38
  "publishConfig": {
29
39
  "access": "public"