@voyager-crew/cli 0.0.0-stage → 0.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Jesse Zhang
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,97 @@
1
- # Temporary Holding Version
1
+ <div align="center">
2
+ <img src="assets/logo.png" alt="Voyager logo" width="96" height="96">
3
+ <h1>voyager</h1>
4
+ <p>Ask ChatGPT from your terminal, or let your coding agent do it,<br>through the ChatGPT you are already signed in to in your browser.</p>
5
+ <p>
6
+ <a href="https://www.npmjs.com/package/@voyager-crew/cli"><img src="https://img.shields.io/npm/v/@voyager-crew/cli?style=flat-square" alt="npm version"></a>
7
+ <img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="MIT license">
8
+ </p>
9
+ <p><b>English</b> • <a href="README_ZH.md">简体中文</a></p>
10
+ </div>
2
11
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
12
+ ```sh
13
+ voyager ask "Review this design" --attach ./docs/design.md
14
+ ```
15
+
16
+ `voyager` hands the prompt to the [Voyager](https://github.com/voyager-crew/voyager) browser
17
+ extension, which types it into a ChatGPT tab, waits for the answer and saves it as
18
+ `response.md`. Everything stays on your machine: the CLI listens on `127.0.0.1` only, and
19
+ ChatGPT sees an ordinary chat from your own browser.
20
+
21
+ ## Setup
22
+
23
+ 1. Install the CLI (Node.js 20.3 or later):
24
+
25
+ ```sh
26
+ npm install -g @voyager-crew/cli
27
+ ```
28
+
29
+ 2. Install Voyager in your browser. In its popup, open **Plugins**, turn on
30
+ **ChatGPT · Local Bridge** and allow access to chatgpt.com.
31
+ 3. Pair them once:
32
+
33
+ ```sh
34
+ voyager pair
35
+ ```
36
+
37
+ Enter the eight-character code it prints in the Local Bridge settings in the popup.
38
+
39
+ ## Asking
40
+
41
+ ```sh
42
+ voyager ask "Explain this stack trace" --attach crash.log
43
+ voyager ask "Look over the repo" --attach ./src # folders go up as a zip, secrets left out
44
+ voyager ask --model high "Quick sanity check" # pro (default), extra-high, high, medium, instant
45
+ voyager ask --chat <link|id> "And the edge cases?" # follow up in a conversation
46
+ voyager read <link|id> # save a conversation's latest reply
47
+ ```
48
+
49
+ Every ask uses GPT-6 Pro in chat mode unless you pick another effort, and leaves it selected.
50
+ Voyager never switches ChatGPT to Work mode. The reply lands in `~/.voyager/jobs/<id>/output/`,
51
+ and `--json` prints its path along with the conversation link.
52
+
53
+ ### Long answers
54
+
55
+ Pro can think for hours. `ask` waits as long as ChatGPT is still working on the reply, and
56
+ only gives up after 20 minutes with no sign of life. To get your terminal back, submit and
57
+ collect later:
58
+
59
+ ```sh
60
+ voyager ask --no-wait "…" # prints a job id
61
+ voyager job wait <id> --timeout 10m # exit 4 means still running: wait again, never resend
62
+ ```
63
+
64
+ ## Projects
65
+
66
+ A ChatGPT project keeps files that every chat in it can read, so a codebase or a paper goes
67
+ up once instead of with every question.
68
+
69
+ ```sh
70
+ voyager project create "Thesis"
71
+ voyager project upload "Thesis" ./thesis # replaced when it changes, skipped when it hasn't
72
+ voyager ask --project "Thesis" "Where is the argument weakest?"
73
+ voyager project files "Thesis"
74
+ voyager project remove "Thesis" old-notes.md # immediate and permanent; asks first
75
+ ```
76
+
77
+ ## Using it from an agent
78
+
79
+ Claude Code, Codex and any other agent that can run shell commands can use `voyager`.
80
+ [`skills/voyager/SKILL.md`](skills/voyager/SKILL.md) is written for them: JSON output, what each
81
+ exit code means, how to wait for a long job without sending the prompt twice, and how to follow
82
+ up with `--chat` and the conversation id it got rather than `--continue`.
83
+
84
+ One job runs at a time. Every result also names your ChatGPT plan (`Pro Lite ($100)`,
85
+ `Pro ($200)`, …) as the page last reported it.
86
+
87
+ ## Good to know
88
+
89
+ - The bridge opens its own ChatGPT tab and closes it when done. If ChatGPT asks you to sign
90
+ in or solve a challenge, `voyager` stops and says so (exit 3); it never works around it.
91
+ - Commands: `voyager --help`. State lives in `~/.voyager` (or `$VOYAGER_HOME`), private to
92
+ your user.
93
+ - Tested in Chrome. Edge and Firefox builds of Voyager include the bridge too; Safari does not.
94
+
95
+ ## License
96
+
97
+ MIT. Development notes are in [CONTRIBUTING.md](CONTRIBUTING.md).
package/README_ZH.md ADDED
@@ -0,0 +1,90 @@
1
+ <div align="center">
2
+ <img src="assets/logo.png" alt="Voyager logo" width="96" height="96">
3
+ <h1>voyager</h1>
4
+ <p>在终端里向 ChatGPT 提问,或者交给你的 coding agent 去问,<br>用的就是你浏览器里已经登录的那个 ChatGPT。</p>
5
+ <p>
6
+ <a href="https://www.npmjs.com/package/@voyager-crew/cli"><img src="https://img.shields.io/npm/v/@voyager-crew/cli?style=flat-square" alt="npm version"></a>
7
+ <img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="MIT license">
8
+ </p>
9
+ <p><a href="README.md">English</a> • <b>简体中文</b></p>
10
+ </div>
11
+
12
+ ```sh
13
+ voyager ask "帮我审一下这份设计" --attach ./docs/design.md
14
+ ```
15
+
16
+ `voyager` 把问题交给 [Voyager](https://github.com/voyager-crew/voyager) 浏览器插件。插件在
17
+ ChatGPT 标签页里填好问题、等它回答完,再把回答存成 `response.md`。全程都在你自己的电脑上:命令行只监听
18
+ `127.0.0.1`,ChatGPT 看到的就是你浏览器里一次普通的对话。
19
+
20
+ ## 安装
21
+
22
+ 1. 安装命令行(需要 Node.js 20.3 或更高版本):
23
+
24
+ ```sh
25
+ npm install -g @voyager-crew/cli
26
+ ```
27
+
28
+ 2. 在浏览器里安装 Voyager。打开插件弹窗,进入 **插件**,打开 **ChatGPT · 本地桥**,并允许访问
29
+ chatgpt.com。
30
+ 3. 配对一次:
31
+
32
+ ```sh
33
+ voyager pair
34
+ ```
35
+
36
+ 把它显示的 8 位配对码填进弹窗里「本地桥」的设置。
37
+
38
+ ## 提问
39
+
40
+ ```sh
41
+ voyager ask "解释一下这段报错" --attach crash.log
42
+ voyager ask "看看这个仓库" --attach ./src # 文件夹会打包成 zip,自动去掉密钥等凭据
43
+ voyager ask --model high "快速检查一下" # pro(默认)、extra-high、high、medium、instant
44
+ voyager ask --chat <链接|id> "边界情况呢?" # 在已有对话里接着问
45
+ voyager read <链接|id> # 保存某个对话的最新回答
46
+ ```
47
+
48
+ 默认用聊天模式下的 GPT-6 Pro,除非你另选思考强度;问完保持在这个选择上。Voyager 不会把 ChatGPT
49
+ 切到「工作」模式。回答保存在 `~/.voyager/jobs/<id>/output/`,加 `--json` 会输出文件路径和对话链接。
50
+
51
+ ### 很长的回答
52
+
53
+ Pro 可能要想好几个小时。只要 ChatGPT 还在写,`ask` 就一直等;连续 20 分钟完全没动静才算失败。想先拿回终端,就先提交、之后再取:
54
+
55
+ ```sh
56
+ voyager ask --no-wait "…" # 输出一个任务 id
57
+ voyager job wait <id> --timeout 10m # 退出码 4 表示还在跑:接着等,千万别重发问题
58
+ ```
59
+
60
+ ## 项目
61
+
62
+ ChatGPT 的项目可以存放文件,项目里的每个对话都能读到。代码库或论文传一次就行,不用每次提问都附上。
63
+
64
+ ```sh
65
+ voyager project create "论文"
66
+ voyager project upload "论文" ./thesis # 内容变了就替换,没变就跳过
67
+ voyager ask --project "论文" "论证最薄弱的地方在哪?"
68
+ voyager project files "论文"
69
+ voyager project remove "论文" old-notes.md # 立即删除且无法恢复,会先确认
70
+ ```
71
+
72
+ ## 给 agent 用
73
+
74
+ Claude Code、Codex 以及任何能运行终端命令的 agent 都能用 `voyager`。
75
+ [`skills/voyager/SKILL.md`](skills/voyager/SKILL.md) 就是写给它们看的:JSON 输出、每个退出码的含义、怎么等长任务而不把问题发两遍,以及接着问时用
76
+ `--chat` 加上次拿到的对话 id,而不是 `--continue`。
77
+
78
+ 同一时间只跑一个任务。每次的结果里还会带上你的 ChatGPT 套餐(`Pro Lite ($100)`、`Pro ($200)`
79
+ 等),以页面最近一次报告的为准。
80
+
81
+ ## 须知
82
+
83
+ - 桥会自己打开一个 ChatGPT 标签页,用完关掉。如果 ChatGPT 要求登录或人机验证,`voyager`
84
+ 会停下来告诉你(退出码 3),不会绕过。
85
+ - 全部命令见 `voyager --help`。状态保存在 `~/.voyager`(或 `$VOYAGER_HOME`),只有你的用户能读。
86
+ - 已在 Chrome 中测试。Edge 和 Firefox 版的 Voyager 也带这个桥;Safari 版没有。
87
+
88
+ ## 许可证
89
+
90
+ MIT。开发说明见 [CONTRIBUTING.md](CONTRIBUTING.md)。