@validflow/ccneed-cli 0.1.0 → 0.1.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.
- package/README.md +57 -65
- package/checksums.json +7 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,126 +1,118 @@
|
|
|
1
1
|
<div align="center">
|
|
2
|
-
<img src="assets/ccneed-logo.png" alt="CCNeed
|
|
2
|
+
<img src="https://raw.githubusercontent.com/validflow/ccneed-cli/main/assets/ccneed-logo.png" alt="CCNeed mascot holding a magnifying glass" width="320">
|
|
3
3
|
<h1>CCNeed CLI</h1>
|
|
4
|
-
<p
|
|
4
|
+
<p>Run research with CCNeed from your own AI agent or terminal.</p>
|
|
5
|
+
<p><a href="README.zh.md">中文</a> | <a href="README.md">English</a></p>
|
|
5
6
|
<p>
|
|
6
|
-
<a href="https://ccneed.ai"
|
|
7
|
-
<a href="INSTALL.md"
|
|
8
|
-
<a href="skills/ccneed/SKILL.md">Skill</a> ·
|
|
9
|
-
<a href="
|
|
10
|
-
<a href="https://github.com/validflow/ccneed-cli/issues">反馈</a>
|
|
7
|
+
<a href="https://ccneed.ai">Website</a> ·
|
|
8
|
+
<a href="INSTALL.md">Installation guide</a> ·
|
|
9
|
+
<a href="skills/ccneed/SKILL.md">Agent Skill</a> ·
|
|
10
|
+
<a href="https://github.com/validflow/ccneed-cli/issues">Issues</a>
|
|
11
11
|
</p>
|
|
12
12
|
</div>
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
CCNeed runs long research tasks in the cloud. Its CLI lets you submit work, follow progress, answer questions, and bring reports back into the agent you already use. The CLI and its companion Skill are installed together.
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
> Some cloud commands depend on the corresponding CCNeed service APIs being available in production.
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## Install
|
|
19
19
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
在自己的电脑上一次安装 CLI 和配套 Skill。将 `AGENT` 换成你使用的 Agent 类型（`codex`、`workbuddy` 或 `claude`）：
|
|
20
|
+
Node.js 22.14+ and npm are required. Choose your agent: `codex`, `workbuddy` (local coding environment), or `claude`.
|
|
23
21
|
|
|
24
22
|
```bash
|
|
25
|
-
npx @validflow/ccneed-cli@latest install --agent
|
|
23
|
+
npx @validflow/ccneed-cli@latest install --agent codex
|
|
26
24
|
```
|
|
27
25
|
|
|
28
|
-
|
|
26
|
+
Replace `codex` with your agent, or use `--agent codex,workbuddy` for both. The installer adds a global `ccneed` command and links the same-version Skill into the selected agent's user directory; it does not modify the current project. Restart your agent after installation.
|
|
29
27
|
|
|
30
28
|
```bash
|
|
31
29
|
ccneed --help
|
|
32
30
|
```
|
|
33
31
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
### 让 Agent 帮你安装
|
|
32
|
+
### Build from source
|
|
37
33
|
|
|
38
|
-
|
|
34
|
+
For development, use Git and Go 1.25+:
|
|
39
35
|
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
36
|
+
```bash
|
|
37
|
+
git clone https://github.com/validflow/ccneed-cli.git
|
|
38
|
+
cd ccneed-cli
|
|
39
|
+
go install ./cmd/ccneed
|
|
40
|
+
ccneed --help
|
|
45
41
|
```
|
|
46
42
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
🔑 使用已有的 CCNeed 官网账号，不用再注册一套账号。
|
|
43
|
+
This builds the development CLI only. The source Skill lives in `skills/ccneed` and is **not** installed or updated automatically by `go install`. For a linked CLI + Skill that update together, use the npm method above. See the [installation guide](INSTALL.md) for PATH and source-build details.
|
|
50
44
|
|
|
51
|
-
|
|
45
|
+
### Ask your agent to install it
|
|
52
46
|
|
|
53
|
-
```
|
|
54
|
-
ccneed
|
|
47
|
+
```text
|
|
48
|
+
Read https://github.com/validflow/ccneed-cli/blob/main/INSTALL.md.
|
|
49
|
+
Install the official CCNeed CLI and Skill for the agent I am using.
|
|
50
|
+
Give me the website authorization link; I will approve the login myself.
|
|
55
51
|
```
|
|
56
52
|
|
|
57
|
-
|
|
53
|
+
## Sign in
|
|
54
|
+
|
|
55
|
+
Use your existing CCNeed account. The CLI opens a website authorization flow; it does not need your password or browser cookies.
|
|
58
56
|
|
|
59
57
|
```bash
|
|
58
|
+
ccneed auth login
|
|
59
|
+
# Open the URL, check the confirmation code, and approve in your browser.
|
|
60
60
|
ccneed auth login --complete --timeout 60s
|
|
61
61
|
ccneed auth status --verify
|
|
62
62
|
ccneed account credits
|
|
63
63
|
```
|
|
64
64
|
|
|
65
|
-
|
|
65
|
+
The default service is `https://ccneed.ai`. Developers can explicitly target staging with `--api-url`; staging and production credentials must stay separate.
|
|
66
66
|
|
|
67
|
-
##
|
|
67
|
+
## Work with CCNeed
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
In your agent, you can ask:
|
|
70
70
|
|
|
71
71
|
```text
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
需要确认的地方请问我。
|
|
72
|
+
Use CCNeed to analyze my posts.csv, find high-value creators, and bring me a PDF report.
|
|
73
|
+
Ask me before making any choice that needs my confirmation.
|
|
75
74
|
```
|
|
76
75
|
|
|
77
|
-
|
|
76
|
+
Or use the CLI directly. Replace example IDs with values returned by your commands:
|
|
78
77
|
|
|
79
78
|
```bash
|
|
80
79
|
ccneed kb list
|
|
81
80
|
ccneed files upload ./posts.csv
|
|
82
|
-
ccneed threads create --title "
|
|
83
|
-
ccneed run "
|
|
81
|
+
ccneed threads create --title "Creator research" --kb-id 7 --file-id FILE_UUID
|
|
82
|
+
ccneed run "Analyze the attached data and prepare a report" --thread-id THREAD_UUID
|
|
84
83
|
```
|
|
85
84
|
|
|
86
|
-
|
|
85
|
+
Uploading a file does not bind it to a conversation automatically. Creating a conversation does not start a task; `run` does. A task may use your CCNeed credits.
|
|
87
86
|
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
`run` 返回会话 ID 和本轮任务 ID 后就退出，研究继续在云端执行：
|
|
87
|
+
`run` returns immediately while the cloud task continues. You can watch the same turn, respond to a confirmation request, and retrieve its results:
|
|
91
88
|
|
|
92
89
|
```bash
|
|
93
90
|
ccneed tasks watch --thread-id THREAD_UUID --turn-id TURN_UUID --timeout 60s
|
|
94
91
|
ccneed artifacts list --thread-id THREAD_UUID
|
|
95
|
-
ccneed artifacts download --thread-id THREAD_UUID --artifact-id ARTIFACT_UUID --output ./report.md
|
|
96
92
|
ccneed artifacts export-pdf --thread-id THREAD_UUID --artifact-id ARTIFACT_UUID --output ./report.pdf
|
|
97
93
|
```
|
|
98
94
|
|
|
99
|
-
`watch`
|
|
95
|
+
For an editable Markdown report, use `ccneed artifacts download` instead. `watch` timing out does not cancel the cloud task; you can check again later. For all options, run `ccneed <command> --help` or read the [Skill](skills/ccneed/SKILL.md).
|
|
100
96
|
|
|
101
|
-
###
|
|
97
|
+
### At a glance
|
|
102
98
|
|
|
103
|
-
|
|
|
99
|
+
| What you need | Command |
|
|
104
100
|
| --- | --- |
|
|
105
|
-
| 💳
|
|
106
|
-
| 💬
|
|
107
|
-
| 📚
|
|
108
|
-
| ➕
|
|
109
|
-
| 📎
|
|
110
|
-
| 🗂️
|
|
111
|
-
| 🕘
|
|
112
|
-
| 🚪
|
|
113
|
-
|
|
114
|
-
表中未展开的参数，可用 `ccneed <命令> --help` 查看。知识库与文件绑定只追加、不解绑；完整调用规则见 [Skill](skills/ccneed/SKILL.md)。
|
|
115
|
-
|
|
116
|
-
## 更新
|
|
101
|
+
| 💳 Check credits and subscription | `ccneed account credits` / `ccneed account overview` |
|
|
102
|
+
| 💬 Find conversations | `ccneed threads list` |
|
|
103
|
+
| 📚 Explore knowledge bases | `ccneed kb list` |
|
|
104
|
+
| ➕ Create a knowledge base in the browser | `ccneed kb create` |
|
|
105
|
+
| 📎 List or upload files | `ccneed files list` / `ccneed files upload ./posts.csv` |
|
|
106
|
+
| 🗂️ View or add conversation resources | `ccneed threads resources` / `ccneed threads append` |
|
|
107
|
+
| 🕘 Review task history | `ccneed tasks list --thread-id THREAD_UUID` |
|
|
108
|
+
| 🚪 Sign out | `ccneed auth logout` |
|
|
117
109
|
|
|
118
|
-
|
|
110
|
+
Knowledge-base and file bindings can be added, but not removed. Use `ccneed <command> --help` for the required arguments.
|
|
119
111
|
|
|
120
|
-
##
|
|
112
|
+
## Update and contribute
|
|
121
113
|
|
|
122
|
-
|
|
114
|
+
Run the same `npx @validflow/ccneed-cli@latest install --agent ...` command to update both the CLI and linked Skill. Reload your agent afterward; update notifications never install software without your action.
|
|
123
115
|
|
|
124
|
-
|
|
116
|
+
Found a problem? [Open an issue](https://github.com/validflow/ccneed-cli/issues) with your OS, CLI version, and a redacted error message. Never post credentials or private files.
|
|
125
117
|
|
|
126
|
-
|
|
118
|
+
[Installation](INSTALL.md) · [Contributing](CONTRIBUTING.md) · [Code style](CODE_STYLE.md) · [Security](SECURITY.md) · [Releasing](RELEASING.md)
|
package/checksums.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.1.
|
|
2
|
+
"version": "0.1.1",
|
|
3
3
|
"assets": {
|
|
4
|
-
"ccneed-0.1.
|
|
5
|
-
"ccneed-0.1.
|
|
6
|
-
"ccneed-0.1.
|
|
7
|
-
"ccneed-0.1.
|
|
8
|
-
"ccneed-0.1.
|
|
9
|
-
"ccneed-0.1.
|
|
4
|
+
"ccneed-0.1.1-linux-amd64": "25658392cbe9c902c954fc36e1b75d1c1c14a2524b733c467d6075ab7f3f75ab",
|
|
5
|
+
"ccneed-0.1.1-linux-arm64": "17c1e4903a3a47c5a1a9fb2fa16030fd855b3f6e328a0ea0316e7dd993f576d3",
|
|
6
|
+
"ccneed-0.1.1-darwin-amd64": "2e97a06ac1fde28a0ab3494d2ea9c0ca5e00ede9d60c51cd15ccd37fd92f956f",
|
|
7
|
+
"ccneed-0.1.1-darwin-arm64": "3c7559a0e2da7fb93712af3d12c61ebb2b2134bb613a7df8a7eb53b26a306cc2",
|
|
8
|
+
"ccneed-0.1.1-windows-amd64.exe": "717a20229dbfe917b6ff940e59a8928eb971e82297fdbecfbd7e5f9dc3d1b037",
|
|
9
|
+
"ccneed-0.1.1-windows-arm64.exe": "9d4dc5b3595535371ea5213623bf8e9579f9906c812fdc2515014efc54adb000"
|
|
10
10
|
},
|
|
11
11
|
"skill_sha256": "5fc9782bdd758d327e192b2c261505dcc0cef4c374df2ccf8d68900586005895"
|
|
12
12
|
}
|