WopalSpace命令行参考
WopalSpace CLI 提供了丰富的命令来管理空间、配置和技能。本文档列出所有可用命令及其详细用法。
全局选项
所有命令都支持以下全局选项：
| 选项 | 缩写 | 说明 | 默认值 |
|---|---|---|---|
--help | -h | 显示帮助信息 | - |
--version | -v | 显示版本号 | - |
--verbose | -V | 启用详细输出 | false |
--quiet | -q | 静默模式，只输出错误 | false |
--no-color | - | 禁用彩色输出 | false |
--config <path> | -c | 指定配置文件路径 | ~/.wopal/config.json |
空间管理
wopal init
初始化一个新的工作空间：
wopal init [options] [directory]
选项：
| 选项 | 说明 | 默认值 |
|---|---|---|
--template <name> | 使用指定模板 | default |
--name <name> | 空间名称 | 目录名 |
--force | 强制初始化（覆盖已有文件） | false |
--minimal | 最小化初始化 | false |
示例：
# 在当前目录初始化
wopal init
# 在指定目录初始化
wopal init ./my-project
# 使用模板初始化
wopal init --template react-typescript
# 最小化初始化（只创建必要文件）
wopal init --minimal
初始化后的目录结构：
my-project/
├── .wopal-space/
│ ├── STRUCTURE.md # 空间结构定义
│ ├── REGULATIONS.md # 空间守则
│ ├── memory/
│ │ └── USER.md # 用户档案
│ └── logs/ # 操作日志
├── INBOX/ # 收件箱
└── AGENTS.md # Agent 入口
wopal status
查看当前空间的状态信息：
wopal status [options]
输出示例：
Space: my-project
Status: ✓ Active
Structure: Valid
Memory: 3 entries
Skills: 5 installed
Last sync: 2024-01-15 14:30:00
wopal switch
快速切换工作空间：
wopal switch <space-name>
示例：
# 切换到指定空间
wopal switch project-a
# 交互式选择
wopal switch
wopal list
列出所有工作空间：
wopal list [options]
| 选项 | 说明 |
|---|---|
--json | 以 JSON 格式输出 |
--short | 只显示名称 |
--path | 显示完整路径 |
AI 交互
wopal chat
启动 AI 对话会话：
wopal chat [options] [message]
选项：
| 选项 | 缩写 | 说明 | 默认值 |
|---|---|---|---|
--model <name> | -m | 指定 AI 模型 | gpt-4 |
--system <prompt> | -s | 自定义系统提示词 | 内置提示词 |
--continue | -C | 继续上次对话 | false |
--file <path> | -f | 附加文件上下文 | - |
--max-tokens <n> | - | 最大输出 token 数 | 4096 |
示例：
# 开始对话
wopal chat
# 直接提问
wopal chat "帮我分析这个项目的结构"
# 使用特定模型
wopal chat -m claude-3 "解释这段代码"
# 继续上次对话
wopal chat --continue
# 附加文件
wopal chat -f src/index.ts "优化这个文件"
wopal run
运行一个特定的任务或脚本：
wopal run <task> [options]
内置任务：
| 任务名 | 说明 |
|---|---|
review | 对当前变更进行代码审查 |
test | 生成并运行测试 |
docs | 生成文档 |
refactor | 重构建议 |
analyze | 项目分析 |
示例：
# 运行代码审查
wopal run review
# 生成文档
wopal run docs --output ./docs
# 运行自定义脚本
wopal run ./scripts/deploy.sh
技能管理
wopal skill list
列出已安装的技能：
wopal skill list [options]
输出示例：
Installed Skills (5):
✓ code-review v1.2.0 - 代码审查
✓ test-generator v2.0.1 - 测试生成
✓ doc-writer v1.1.0 - 文档编写
✓ git-helper v1.3.2 - Git 辅助
⚠ deploy-assistant v0.9.0 - 部署辅助 (需要配置)
wopal skill install
安装新技能：
wopal skill install <name|url> [options]
| 选项 | 说明 |
|---|---|
--version <ver> | 指定版本 |
--global | 全局安装 |
--dev | 开发模式安装 |
示例：
# 从注册表安装
wopal skill install code-review
# 从 GitHub 安装
wopal skill install github:user/skill-name
# 从本地路径安装
wopal skill install ./my-skill
# 安装指定版本
wopal skill install code-review --version 1.2.0
wopal skill create
创建自定义技能：
wopal skill create <name> [options]
示例：
# 创建新技能
wopal skill create my-analyzer
# 使用模板创建
wopal skill create my-analyzer --template analyzer
创建后的技能目录结构：
.wopal-space/skills/my-analyzer/
├── skill.json # 技能配置
├── README.md # 技能说明
├── prompts/
│ └── default.md # 默认提示词
└── commands/
└── analyze.sh # 可执行命令
记忆管理
wopal memory
管理空间的 AI 记忆：
wopal memory <command> [options]
子命令：
| 命令 | 说明 |
|---|---|
list | 列出所有记忆条目 |
add <content> | 添加新记忆 |
remove <id> | 删除指定记忆 |
sync | 同步记忆到远程 |
export | 导出记忆为 JSON |
import <file> | 导入记忆 |
clear | 清空所有记忆 |
示例：
# 列出记忆
wopal memory list
# 添加记忆
wopal memory add "这个项目使用 PostgreSQL 数据库"
# 同步记忆
wopal memory sync
# 导出记忆
wopal memory export > memories.json
配置管理
wopal config
管理 CLI 配置：
wopal config <command> [options]
子命令：
# 查看配置
wopal config get [key]
# 设置配置
wopal config set <key> <value>
# 删除配置
wopal config unset <key>
# 列出所有配置
wopal config list
# 重置为默认配置
wopal config reset
常用配置项：
| 配置键 | 说明 | 类型 | 默认值 |
|---|---|---|---|
ai.provider | AI 提供商 | string | openai |
ai.model | 默认模型 | string | gpt-4 |
ai.apiKey | API 密钥 | string | - |
ai.maxTokens | 最大 token 数 | number | 4096 |
editor.default | 默认编辑器 | string | code |
spaces.dir | 空间存放目录 | string | ~/.wopal/spaces |
ui.language | 界面语言 | string | zh-CN |
ui.theme | 主题 | string | auto |
诊断工具
wopal doctor
运行系统诊断，检查环境是否正常：
wopal doctor [options]
检查项目：
- Node.js 版本是否满足要求
- Git 是否安装并配置
- 配置文件是否存在且有效
- API Key 是否已设置
- 空间目录是否可写
- 网络连接是否正常
wopal debug
输出调试信息，用于问题报告：
wopal debug [options]
输出内容：
WopalSpace Debug Info
=====================
CLI Version: 1.2.0
Node.js: v20.10.0
OS: macOS 14.2 (arm64)
Shell: /bin/zsh
Git: 2.43.0
Config: ~/.wopal/config.json
Spaces Dir: ~/.wopal/spaces
Active Space: my-project
Skills: 5 installed
Memory Entries: 12
Log File: ~/.wopal/logs/wopal.log
退出码
| 退出码 | 说明 |
|---|---|
0 | 成功 |
1 | 通用错误 |
2 | 参数错误 |
3 | 配置错误 |
4 | 网络错误 |
5 | 权限错误 |
10 | 空间不存在 |
11 | 空间结构无效 |
20 | 技能安装失败 |
30 | AI 服务不可用 |