@geekjourneyx/findo 1.0.0 → 1.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.
Files changed (3) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/README.md +60 -4
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # Changelog
2
2
 
3
+ ## v1.2.0
4
+
5
+ - Embed the Findo Agent skill in the release binary.
6
+ - Add `findo skills list/read` so agents can discover and read the current-version SOP without relying on stale external docs.
7
+ - Extend release checks to guard embedded skill documentation and version consistency.
8
+
9
+ ## v1.1.0
10
+
11
+ - Add default config initialization, path discovery, and redacted config inspection.
12
+
3
13
  ## v1.0.0
4
14
 
5
15
  - Initial stable CLI contract.
package/README.md CHANGED
@@ -27,7 +27,7 @@ The npm package installs the matching GitHub Release binary for your platform an
27
27
  Alternative Go install:
28
28
 
29
29
  ```bash
30
- go install github.com/geekjourneyx/findo/cmd/findo@v1.0.0
30
+ go install github.com/geekjourneyx/findo/cmd/findo@v1.2.0
31
31
  ```
32
32
 
33
33
  Prebuilt binaries and checksums are available on the [GitHub Releases](https://github.com/geekjourneyx/findo/releases) page.
@@ -41,7 +41,22 @@ make build
41
41
 
42
42
  ## Configure
43
43
 
44
- Set the credentials for the providers you want to use:
44
+ Initialize the default config file:
45
+
46
+ ```bash
47
+ findo config init
48
+ findo config path
49
+ ```
50
+
51
+ This creates a config file at the platform default path. On Linux this is typically:
52
+
53
+ ```text
54
+ ~/.config/findo/config.yaml
55
+ ```
56
+
57
+ Run `findo config path` for the exact path on your machine.
58
+
59
+ Edit that file and set the credentials for the providers you want to use:
45
60
 
46
61
  | Provider | Environment variables |
47
62
  | --- | --- |
@@ -49,18 +64,47 @@ Set the credentials for the providers you want to use:
49
64
  | Volcengine Ark | `ARK_API_KEY` or `VOLCENGINE_API_KEY` |
50
65
  | Zhihu | `ZHIHU_ACCESS_SECRET` or `ZHIHU_API_KEY` |
51
66
 
67
+ The config file uses the same provider fields:
68
+
69
+ ```yaml
70
+ bocha:
71
+ api_key: ""
72
+
73
+ volcengine:
74
+ api_key: ""
75
+ model: doubao-seed-2-0-lite-260215
76
+
77
+ zhihu:
78
+ access_secret: ""
79
+ ```
80
+
52
81
  Configuration precedence is:
53
82
 
54
83
  1. CLI flags
55
84
  2. Environment variables
56
- 3. Config file
85
+ 3. `--config` file or `~/.config/findo/config.yaml`
57
86
  4. Built-in defaults
58
87
 
88
+ Inspect the merged config without leaking secrets:
89
+
90
+ ```bash
91
+ findo config show --json
92
+ ```
93
+
94
+ Before publishing a release, verify version alignment across `package.json`, `Makefile`, `CHANGELOG.md`, and the release tag:
95
+
96
+ ```bash
97
+ make version-check
98
+ make release-check
99
+ ```
100
+
59
101
  ## Quick Start
60
102
 
61
103
  ```bash
62
104
  findo version
63
105
  findo sources --json
106
+ findo skills list --json
107
+ findo skills read findo --json
64
108
 
65
109
  BOCHA_API_KEY=... findo bocha "AI Agent 商业化" --json
66
110
  ARK_API_KEY=... findo volc "瑞幸咖啡 2026 门店数是否可信" --json
@@ -71,13 +115,25 @@ ZHIHU_ACCESS_SECRET=... findo hot zhihu --json
71
115
 
72
116
  Human output defaults to a table. Use `--json` for scripts, agents, CI, and downstream tools.
73
117
 
118
+ ## Agent Skill
119
+
120
+ Findo embeds its Agent SOP in the release binary so agents can read instructions that match the executable on `PATH`:
121
+
122
+ ```bash
123
+ findo skills list --json
124
+ findo skills read findo
125
+ findo skills read findo --json
126
+ ```
127
+
128
+ `skills read` defaults to raw Markdown for direct agent context. With `--json`, the same content is returned in the `content` field with version metadata. Use this when an external skill install, README, or repository checkout may be older than the installed CLI.
129
+
74
130
  ## Output
75
131
 
76
132
  Retrieval commands return a stable envelope. A successful JSON response looks like this:
77
133
 
78
134
  ```json
79
135
  {
80
- "version": "1.0.0",
136
+ "version": "1.2.0",
81
137
  "query": {
82
138
  "text": "AI Agent 商业化",
83
139
  "mode": "search",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@geekjourneyx/findo",
3
- "version": "1.0.0",
3
+ "version": "1.2.0",
4
4
  "description": "Install the findo CLI from the matching GitHub Release bundle.",
5
5
  "license": "MIT",
6
6
  "repository": {