docs: add README documentation

- Add project description and features
- Document usage instructions and commands
- Add configuration options table
- Include installation and development guide

🤖 Generated with [Qoder](https://qoder.com)
This commit is contained in:
yuantao
2026-03-27 15:36:44 +08:00
parent 1d777402dc
commit 5fdd678aef

82
README.md Normal file
View File

@@ -0,0 +1,82 @@
# Qoder CLI for VS Code
在 VS Code 编辑器标签页中打开终端,并自动启动 Qoder CLI。
## 功能
- **在编辑器标签页中打开终端** - 将终端作为普通编辑器标签页打开,而不是在底部面板
- **自动启动 Qoder CLI** - 终端打开后自动运行 `qodercli` 命令
- **锁定编辑器组** - 自动锁定终端所在的编辑器组,防止意外关闭
- **支持当前目录** - 可以在当前文件所在目录或选中的文件夹中打开终端
## 使用方法
### 命令
1. **Open Terminal Tab** (`terminalTab.open`)
- 在编辑器区域新建一个终端标签页
- 默认在工作区根目录打开
2. **Open Terminal Tab (Current Directory)** (`terminalTab.openInCurrentDirectory`)
- 在当前文件所在目录打开终端标签页
- 也可通过右键菜单在资源管理器中使用
### 快捷操作
- 点击编辑器标题栏的终端图标,在当前文件目录打开终端
- 在资源管理器中右键点击文件或文件夹,选择 "Open Terminal Tab (Current Directory)"
## 配置
在 VS Code 设置中搜索 "Terminal Tab" 进行配置:
| 配置项 | 类型 | 默认值 | 说明 |
|--------|------|--------|------|
| `terminalTab.defaultLocation` | string | `"editor"` | 终端默认打开位置 (`"editor"``"panel"`) |
| `terminalTab.preserveFocus` | boolean | `false` | 打开终端时是否保持焦点在当前编辑器 |
## 安装
### 从 VSIX 安装
1. 下载 `qoder-cli-vscode-0.0.1.vsix` 文件
2. 在 VS Code 中打开扩展面板 (Ctrl+Shift+X)
3. 点击右上角的 "..." 菜单,选择 "从 VSIX 安装"
4. 选择下载的文件
### 从源码安装
```bash
npm install
npm run compile
```
然后按 F5 在扩展开发主机中运行。
## 开发
```bash
# 安装依赖
npm install
# 编译
npm run compile
# 监视模式编译
npm run watch
# 运行测试
npm run test
# 打包
vsce package
```
## 要求
- VS Code 1.74.0 或更高版本
- 已安装 Qoder CLI (`qodercli`)
## 许可证
MIT