SCode CLI

一个功能强大的AI命令行界面工具，参考了Codex、Gemini CLI等优秀项目的设计理念。

功能特性

• 💬 交互式聊天 - 支持流式响应的对话模式
• ❓ 快速问答 - 一次性问题快速获取答案
• 💻 代码生成 - 根据描述生成代码，支持多种编程语言
• 📖 代码解释 - 解释现有代码的功能
• 🔍 代码审查 - 提供代码改进建议
• ⚙️ 灵活配置 - 支持自定义API端点、模型、参数等

安装

# 克隆项目
git clone <repository-url>cd scode-cli
# 安装依赖
npm install

快速开始

1. 配置API密钥

# 设置OpenAI API密钥
npm run dev -- config api-key sk-your-api-key-here
# 或者使用其他OpenAI兼容的API
npm run dev -- config set api.baseUrl https://your-custom-api.com/v1
npm run dev -- config set api.model gpt-4

2. 开始使用

# 快速问答
npm run dev -- ask "什么是TypeScript？"# 交互式聊天
npm run dev -- chat
# 生成代码
npm run dev -- code generate "一个React按钮组件" -o Button.tsx -l TypeScript
# 解释代码
npm run dev -- code explain src/index.ts
# 审查代码
npm run dev -- code review src/index.ts

命令详解

config - 配置管理

# 查看当前配置
npm run dev -- config list
# 设置配置项
npm run dev -- config set api.model gpt-4
npm run dev -- config set api.temperature 0.5
# 设置API密钥
npm run dev -- config api-key sk-...
# 清除所有配置
npm run dev -- config clear

chat - 交互式聊天

# 直接进入聊天模式
npm run dev -- chat
# 带初始消息进入聊天
npm run dev -- chat "帮我写一个Python函数"# 禁用流式响应
npm run dev -- chat --no-stream
# 指定模型
npm run dev -- chat -m gpt-4

ask - 快速问答

# 简单问答
npm run dev -- ask "如何学习JavaScript？"# 启用流式响应
npm run dev -- ask -s "解释一下REST API"# 调整温度参数
npm run dev -- ask -t 0.9 "给我一些创意想法"

code - 代码相关命令

# 生成代码
npm run dev -- code generate "冒泡排序算法" -l Python -o sort.py
# 解释代码文件
npm run dev -- code explain sort.py
# 审查代码并提供建议
npm run dev -- code review sort.py
# 使用特定模型
npm run dev -- code generate "一个Vue组件" -m gpt-4

配置选项

配置项	默认值	说明
api.baseUrl	https://api.openai.com/v1	API端点地址
api.model	gpt-4	使用的模型
api.maxTokens	2048	最大生成token数
api.temperature	0.7	温度参数 (0-2)

开发

# 开发模式运行
npm run dev
# 编译项目
npm run build
# 代码格式化
npm run format
# 代码检查
npm run lint

项目结构

scode-cli/
├── src/
│ ├── index.ts # 主入口文件
│ ├── config.ts # 配置管理
│ ├── ai-client.ts # AI客户端
│ ├── commands-config.ts # 配置命令
│ ├── commands-chat.ts # 聊天命令
│ ├── commands-ask.ts # 问答命令
│ └── commands-code.ts # 代码命令
├── package.json
├── tsconfig.json
└── README.md

技术栈

• Node.js - 运行时环境
• TypeScript - 类型安全
• Commander.js - 命令行解析
• Chalk - 终端彩色输出
• Inquirer - 交互式提示
• Ora - 加载动画
• Conf - 配置管理

许可证

MIT