@geekjourneyx/findo 1.0.0 → 1.1.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/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Changelog
2
2
 
3
+ ## v1.1.0
4
+
5
+ - Add default config initialization, path discovery, and redacted config inspection.
6
+
3
7
  ## v1.0.0
4
8
 
5
9
  - Initial stable CLI contract.
package/README.md CHANGED
@@ -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,13 +64,40 @@ 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
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@geekjourneyx/findo",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "description": "Install the findo CLI from the matching GitHub Release bundle.",
5
5
  "license": "MIT",
6
6
  "repository": {