vole-agent 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/README.md ADDED
@@ -0,0 +1,83 @@
1
+ # vole-agent
2
+
3
+ A capable coding and general-purpose agent for your terminal.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ npm install -g vole-agent
9
+ ```
10
+
11
+ ## Setup
12
+
13
+ Set your API key in your shell profile or a `.env` file in your project root:
14
+
15
+ ```bash
16
+ # Anthropic
17
+ export VOLE_API_KEY=sk-ant-...
18
+
19
+ # or OpenRouter
20
+ export OPENROUTER_API_KEY=sk-or-...
21
+ ```
22
+
23
+ ## Usage
24
+
25
+ ```bash
26
+ # Interactive chat
27
+ vole chat
28
+
29
+ # Resume previous session
30
+ vole chat --resume
31
+
32
+ # One-shot task
33
+ vole run "refactor the auth module to use async/await"
34
+
35
+ # Web dashboard
36
+ vole web
37
+
38
+ # List sessions
39
+ vole sessions
40
+ ```
41
+
42
+ ## Commands
43
+
44
+ | Command | Description |
45
+ |---|---|
46
+ | `vole chat` | Start an interactive chat session |
47
+ | `vole chat --resume` | Resume the most recent session |
48
+ | `vole chat --session <id>` | Resume a specific session |
49
+ | `vole run "<goal>"` | Run a one-shot background task |
50
+ | `vole web` | Open the web dashboard |
51
+ | `vole sessions` | List stored sessions |
52
+ | `vole tasks` | List background task runs |
53
+ | `vole skills` | Manage agent skills |
54
+
55
+ ## Chat slash commands
56
+
57
+ Inside `vole chat`:
58
+
59
+ | Command | Description |
60
+ |---|---|
61
+ | `/resume` | Pick and resume a previous session |
62
+ | `/clear` | Clear screen and reset context |
63
+ | `/trace` | Show recent event trace |
64
+ | `/config` | Show current configuration |
65
+ | `/skills` | List loaded skills |
66
+ | `/help` | Show all commands |
67
+ | `/exit` | Leave chat |
68
+
69
+ ## Configuration
70
+
71
+ All configuration is via environment variables:
72
+
73
+ | Variable | Default | Description |
74
+ |---|---|---|
75
+ | `VOLE_API_KEY` | — | Anthropic API key |
76
+ | `OPENROUTER_API_KEY` | — | OpenRouter API key (alternative) |
77
+ | `VOLE_MODEL` | `claude-sonnet-4-6` | Model to use |
78
+ | `VOLE_MODEL_PROVIDER` | `anthropic` | Provider (`anthropic` or `openai-compatible`) |
79
+ | `VOLE_MAX_TOKENS` | `16000` | Max output tokens |
80
+
81
+ ## License
82
+
83
+ MIT
@@ -0,0 +1,81 @@
1
+ # vole-agent
2
+
3
+ 功能强大的编程和通用智能体,在终端中运行。
4
+
5
+ ## 安装
6
+
7
+ ```bash
8
+ npm install -g vole-agent
9
+ ```
10
+
11
+ ## 配置
12
+
13
+ 在 shell 配置文件或项目根目录的 `.env` 文件中设置 API key:
14
+
15
+ ```bash
16
+ # Anthropic
17
+ export VOLE_API_KEY=sk-ant-...
18
+
19
+ # 或 OpenRouter
20
+ export OPENROUTER_API_KEY=sk-or-...
21
+ ```
22
+
23
+ ## 使用
24
+
25
+ ```bash
26
+ # 交互式对话
27
+ vole chat
28
+
29
+ # 恢复上次会话
30
+ vole chat --resume
31
+
32
+ # 一次性任务
33
+ vole run "重构 auth 模块,使用 async/await"
34
+
35
+ # Web 界面
36
+ vole web
37
+
38
+ # 列出会话
39
+ vole sessions
40
+ ```
41
+
42
+ ## 命令
43
+
44
+ | 命令 | 说明 |
45
+ |---|---|
46
+ | `vole chat` | 开始交互式对话 |
47
+ | `vole chat --resume` | 恢复最近的会话 |
48
+ | `vole chat --session <id>` | 恢复指定会话 |
49
+ | `vole run "<目标>"` | 运行一次性后台任务 |
50
+ | `vole web` | 打开 Web 界面 |
51
+ | `vole sessions` | 列出所有会话 |
52
+ | `vole tasks` | 列出后台任务记录 |
53
+ | `vole skills` | 管理智能体技能 |
54
+
55
+ ## 对话内指令
56
+
57
+ 在 `vole chat` 中可用:
58
+
59
+ | 指令 | 说明 |
60
+ |---|---|
61
+ | `/resume` | 选择并恢复历史会话 |
62
+ | `/clear` | 清屏并重置上下文 |
63
+ | `/trace` | 查看最近事件追踪 |
64
+ | `/config` | 查看当前配置 |
65
+ | `/skills` | 列出已加载技能 |
66
+ | `/help` | 显示所有指令 |
67
+ | `/exit` | 退出对话 |
68
+
69
+ ## 环境变量配置
70
+
71
+ | 变量 | 默认值 | 说明 |
72
+ |---|---|---|
73
+ | `VOLE_API_KEY` | — | Anthropic API key |
74
+ | `OPENROUTER_API_KEY` | — | OpenRouter API key(备选) |
75
+ | `VOLE_MODEL` | `claude-sonnet-4-6` | 使用的模型 |
76
+ | `VOLE_MODEL_PROVIDER` | `anthropic` | 提供商(`anthropic` 或 `openai-compatible`) |
77
+ | `VOLE_MAX_TOKENS` | `16000` | 最大输出 token 数 |
78
+
79
+ ## 许可证
80
+
81
+ MIT