# LambdaCLI

**Repository Path**: scrat19/lambda-cli

## Basic Information

- **Project Name**: LambdaCLI
- **Description**: A CLI tool with MCP (Model Context Protocol) server integration, designed to be called by AI Agents and to remotely invoke REST APIs.
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-04-14
- **Last Updated**: 2026-04-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OmniCLI v0.7.1

[![npm version](https://img.shields.io/npm/v/omnicli-mcp)](https://www.npmjs.com/package/omnicli-mcp)
[![npm downloads](https://img.shields.io/npm/dm/omnicli-mcp)](https://www.npmjs.com/package/omnicli-mcp)
[![Node.js Version](https://img.shields.io/node/v/omnicli-mcp)](https://nodejs.org)
[![License: MIT](https://img.shields.io/npm/l/omnicli-mcp)](https://opensource.org/licenses/MIT)

> AI 智能支配平台 (CLI + Skills Server)，让 AI Agent 通过 REST API 调用任意远程 API

## 📖 简介

OmniCLI 是一个强大的命令行工具，配合 Skills 服务器，为 AI Agent 提供统一的 REST API 调用接口。支持多端点管理、多种认证方式、请求历史追踪、测试自动化等功能，是构建 AI 应用的理想基础设施。

### ✨ 核心特性

- **🎯 多端点管理** - 统一管理多个 REST API 端点，支持多种认证方式（API Key、Bearer Token、OAuth2、Cookie）
- **🤖 Skills 服务器** - 三层 Skills 加载（内置 → 场景 → 端点自动生成），让 AI Agent 通过 HTTP 协议发现和执行
- **⚡ 别名系统** - 为常用 API 调用创建快捷别名，`omni api call +dc` 一键调用
- **🔗 统一调用** - `omni api call` 支持 positional args、别名、flag 三种调用方式
- **📜 请求历史** - 完整记录所有 API 调用，支持搜索、重放和统计分析
- **🧪 测试自动化** - 从 OpenAPI 规范自动生成测试用例，支持 Mock 服务器
- **📚 文档生成** - 一键生成 API 文档（Markdown 格式）
- **🔌 插件系统** - 可扩展的插件架构，支持自定义命令和钩子
- **🤖 AI 集成** - 内置 LLM Provider 支持（OpenAI、Anthropic、本地模型）
- **🔄 工作流引擎** - 自动化复杂 API 调用序列
- **📊 监控平台** - 实时健康检查、指标追踪、SLA 监控
- **🔍 智能捕获** - 从浏览器 DevTools 自动捕获和整理 API 请求

## 🚀 快速开始

### 安装

```bash
# 克隆项目
git clone https://github.com/yourusername/omnicli.git
cd OmniCLI

# 安装依赖
npm install

# 构建
npm run build
```

### 基本使用

```bash
# 添加端点
omni config add-endpoint \
  --id jp \
  --name "JSONPlaceholder" \
  --url https://jsonplaceholder.typicode.com \
  --auth-type api-key

# 调用 API（传统 flag 方式）
omni api call -e jp -m GET -p /posts/1

# 调用 API（positional args 方式）
omni api call jp -m GET -p /posts/1

# 注册 API 后用别名快速调用
omni api register --endpoint jp --api getPost --method GET --path /posts/1
omni alias add +post jp getPost --description "获取帖子"
omni api call +post

# 启动 Skills 服务器
omni skills start
```

## 📖 详细文档

所有详细文档在 [`docs/`](docs/) 目录，请先阅读 [`docs/INDEX.md`](docs/INDEX.md) 获取导航。

| 文档 | 内容 |
|------|------|
| [`docs/INDEX.md`](docs/INDEX.md) | 文档导航目录（从这里开始） |
| [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) | 40+ CLI 命令 + 20 个核心模块完整 API 签名 |
| [`docs/OPERATING_MANUAL.md`](docs/OPERATING_MANUAL.md) | CLI 用户操作手册（使用示例） |
| [`docs/SKILLS_SERVER.md`](docs/SKILLS_SERVER.md) | Skills 服务器架构 + REST API 协议 |
| [`docs/TESTING.md`](docs/TESTING.md) | 205 个测试用例清单 + 运行命令 |
| [`docs/ROADMAP.md`](docs/ROADMAP.md) | 产品愿景 + 分阶段路线图 |
| [`docs/qa/`](docs/qa/) | QA 测试报告 |

## 🧪 测试

```bash
npm test            # 运行全部 205 个测试用例（含真实网络调用）
npm run test:watch  # 监视模式运行测试
```

## 🛠️ 技术栈

- **语言**: TypeScript 5.3
- **运行时**: Node.js 18+
- **CLI 框架**: oclif v4
- **HTTP 客户端**: axios
- **测试框架**: Jest + ts-jest
- **协议**: REST API
- **Skills 服务器**: Node.js http（零外部依赖）

## 📦 项目统计

| 维度 | 数量 |
|------|------|
| CLI 命令 | 41+ |
| 核心模块 | 20 个 |
| 源文件 | 88+ 个 |
| 测试套件 | 15 套 |
| 测试用例 | 205 个 |

## 🔧 配置文件位置

配置文件存储在用户主目录下：

- **Windows**: `C:\Users\<Username>\.omni\`
- **Linux/macOS**: `~/.omni/`

### 持久化文件清单

| 文件/目录 | 作用 |
|-----------|------|
| `omni.config.json` | 端点配置、Token 信息 |
| `aliases.json` | API 调用别名映射 |
| `scenarios/` | 场景 Skills 定义文件 |
| `history.jsonl` | API 调用历史记录 |
| `apis/` | API 定义注册表（按端点分目录） |
| `plugins.json` | 插件注册信息 |
| `ai-config.json` | LLM 提供者配置 |
| `test-suite.json` | 测试套件 |
| `test-spec.json` | 测试规范 |
| `templates/` | 用户自定义模板 |
| `drafts/` | 草稿录制会话 |

## 🤝 贡献指南

我们欢迎所有形式的贡献！

### 如何贡献

1. Fork 本仓库
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 提交 Pull Request

### 开发指南

```bash
# 克隆仓库
git clone https://github.com/yourusername/omnicli.git
cd omnicli

# 安装依赖
npm install

# 开发模式运行
npm run dev

# 运行测试
npm test

# 代码检查
npm run lint
npm run lint:fix

# 构建
npm run build
```

### 代码规范

- 遵循 TypeScript 最佳实践
- 使用 ESLint 进行代码检查
- 所有新功能必须包含测试
- 更新相关文档（ARCHITECTURE.md、OPERATING_MANUAL.md）

## 📄 许可证

本项目采用 [MIT](LICENSE) 许可证。

## 👥 作者与社区

### 作者

- **Your Name** - *初始工作* - [YourUsername](https://github.com/yourusername)

## 📧 联系方式

- **项目主页**: [https://github.com/yourusername/omnicli](https://github.com/yourusername/omnicli)
- **问题反馈**: [GitHub Issues](https://github.com/yourusername/omnicli/issues)
- **讨论区**: [GitHub Discussions](https://github.com/yourusername/omnicli/discussions)

## 🙏 致谢

感谢所有为本项目做出贡献的开发者！

特别感谢以下开源项目：

- [oclif](https://oclif.io/) - 强大的 CLI 框架
- [axios](https://axios-http.com/) - HTTP 客户端
- [Jest](https://jestjs.io/) - 测试框架

## 📊 项目状态

| 维度 | 状态 | 详情 |
|------|------|------|
| TypeScript 编译 | ✅ 通过 | 0 errors |
| Jest 单元测试 | ✅ 通过 | 15 suites, 205 tests |
| 构建产物 | ✅ 完整 | 101/101 .js + 101/101 .d.ts |

---

**OmniCLI v0.7.1** - 让 AI Agent 轻松调用任何 REST API