npm package: @longtoon/longto
Description: [![LongTo CLI CI](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml) [![LongTo CLI E2E](https://github.com/google-gemini/gemini-cli/actions/workflows/e2e.y
Latest version: 0.0.4

# LongTo CLI

[![LongTo CLI CI](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml)
[![LongTo CLI E2E](https://github.com/google-gemini/gemini-cli/actions/workflows/e2e.yml/badge.svg)](https://github.com/google-gemini/gemini-cli/actions/workflows/e2e.yml)
[![Version](https://img.shields.io/npm/v/@longtoon/longto)](https://www.npmjs.com/package/@longtoon/longto)
[![License](https://img.shields.io/github/license/google-gemini/gemini-cli)](https://github.com/google-gemini/gemini-cli/blob/main/LICENSE)

![LongTo CLI Screenshot](./docs/assets/gemini-screenshot.png)

LongTo CLI 是一个开源的AI代理工具，将强大的多模型AI能力直接集成到您的终端中。它提供轻量级的AI访问方式，让您能够最直接地从提示词到模型响应，支持包括Gemini和GLM在内的多种AI模型。

## 🚀 为什么选择 LongTo CLI？

- **🎯 免费使用**: 支持GLM-4.5-Flash模型，根据智谱AI官方文档提供免费使用额度。
- **🧠 多模型支持**: 集成Gemini 2.5 Pro（1M token上下文窗口）和GLM-4.5-Flash等先进AI模型。
- **🔧 内置工具**: Google搜索、文件操作、Shell命令、网络获取等强大功能。
- **🔌 可扩展性**: 支持MCP（模型上下文协议）进行自定义集成。
- **💻 终端优先**: 为习惯在命令行工作的开发者设计。
- **🛡️ 开源**: Apache 2.0许可证，完全开源。

## 📦 Installation

### 快速安装

#### 使用npx直接运行（无需安装）

```bash
# 使用npx（无需安装）
npx https://github.com/LongToon/LongTo-Cli
```

#### 使用npm全局安装

```bash
npm install -g @longtoon/longto
```

#### 使用Homebrew全局安装（macOS/Linux）

```bash
brew install longto-cli
```

#### System Requirements

- Node.js version 20 or higher
- macOS, Linux, or Windows

## Release Cadence and Tags

See [Releases](./docs/releases.md) for more details.

### 预览版

预览版将于每周二UTC时间23:59发布。这些版本尚未完全验证，可能包含回归或其他未解决的问题。请帮助我们测试并使用`preview`标签安装。

```bash
npm install -g @longtoon/longto@preview
```

### 稳定版

稳定版将于每周二UTC时间20:00发布，这是上周预览版的完整推广版本，包含任何错误修复和验证。使用`latest`标签。

```bash
npm install -g @longtoon/longto@latest
```

### 每日版

每日版将于每天UTC时间00:00发布，包含发布时主分支的所有更改。应假定有待处理的验证和问题。使用`nightly`标签。

```bash
npm install -g @longtoon/longto@nightly
```

## 📋 Key Features

### Code Understanding & Generation

- Query and edit large codebases
- Generate new apps from PDFs, images, or sketches using multimodal capabilities
- Debug issues and troubleshoot with natural language

### Automation & Integration

- Automate operational tasks like querying pull requests or handling complex
  rebases
- Use MCP servers to connect new capabilities, including
  [media generation with Imagen, Veo or Lyria](https://github.com/GoogleCloudPlatform/vertex-ai-creative-studio/tree/main/experiments/mcp-genmedia)
- Run non-interactively in scripts for workflow automation

### Advanced Capabilities

- Ground your queries with built-in
  [Google Search](https://ai.google.dev/gemini-api/docs/grounding) for real-time
  information
- Conversation checkpointing to save and resume complex sessions
- Custom context files (GEMINI.md) to tailor behavior for your projects

### GitHub Integration

Integrate LongTo CLI directly into your GitHub workflows with
[**LongTo CLI GitHub Action**](https://github.com/google-github-actions/run-gemini-cli):

- **Pull Request Reviews**: Automated code review with contextual feedback and
  suggestions
- **Issue Triage**: Automated labeling and prioritization of GitHub issues based
  on content analysis
- **On-demand Assistance**: Mention `@gemini-cli` in issues and pull requests
  for help with debugging, explanations, or task delegation
- **Custom Workflows**: Build automated, scheduled and on-demand workflows
  tailored to your team's needs

## 🔐 认证选项

选择最适合您需求的认证方式：

### 选项1: 使用GLM API Key（推荐免费使用）

**✨ 最适合:** 个人开发者、学生以及希望免费使用AI模型的用户

**优势:**

- **完全免费**: GLM-4.5-Flash模型根据智谱AI官方文档提供免费使用额度
- **高性能**: GLM-4.5-Flash是智谱AI的高效模型，响应速度快
- **简单配置**: 只需设置API密钥即可开始使用
- **中文优化**: 专为中文场景优化，理解更准确

#### 配置GLM API Key

```bash
# 创建.env文件
echo GLM_API_KEY=your_glm_api_key > .env
echo GLM_MODEL=glm-4.5-flash >> .env

# 或者设置环境变量
export GLM_API_KEY="your_glm_api_key"
export GLM_MODEL=glm-4.5-flash"

# 启动LongTo CLI
longto
```

### 选项2: 使用Google账号登录（OAuth）

**✨ 最适合:** 拥有Gemini Code Assist许可证的个人开发者

**优势:**

- **免费额度**: 每分钟60次请求，每天1000次请求
- **Gemini 2.5 Pro** 支持1M token上下文窗口
- **无需API密钥管理** - 只需使用Google账号登录
- **自动更新** 到最新模型

#### 启动LongTo CLI，然后选择"Login with Google"并按照浏览器认证流程操作

```bash
longto
```

#### 如果您使用组织的付费Code Assist许可证，请记得设置Google Cloud项目

```bash
# 设置您的Google Cloud项目
export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"
longto
```

### 选项3: Gemini API Key

**✨ 最适合:** 需要特定模型控制或付费层访问的开发者

**优势:**

- **免费额度**: 每天100次请求，使用Gemini 2.5 Pro
- **模型选择**: 可选择特定的Gemini模型
- **按使用付费**: 需要时升级以获得更高限制

```bash
# 从https://aistudio.google.com/apikey获取您的密钥
export GEMINI_API_KEY="YOUR_API_KEY"
longto
```

### 选项4: Vertex AI

**✨ 最适合:** 企业团队和生产工作负载

**优势:**

- **企业功能**: 高级安全性和合规性
- **可扩展**: 使用计费账户获得更高的速率限制
- **集成**: 与现有Google Cloud基础设施配合使用

```bash
# 从Google Cloud控制台获取您的密钥
export GOOGLE_API_KEY="YOUR_API_KEY"
export GOOGLE_GENAI_USE_VERTEXAI=true
longto
```

有关Google Workspace帐户和其他认证方法的更多信息，请参阅
[认证指南](./docs/get-started/authentication.md)。

## 🚀 快速开始

### 基本用法

#### 在当前目录启动

```bash
longto
```

#### 包含多个目录

```bash
longto --include-directories ../lib,../docs
```

#### 使用特定模型

```bash
# 使用GLM模型
longto -m glm-4.5-flash

# 使用Gemini模型
longto -m gemini-2.5-flash
```

#### 脚本非交互模式

获取简单的文本响应：

```bash
longto -p "解释这个代码库的架构"
```

对于更高级的脚本编写，包括如何解析JSON和处理错误，使用
`--output-format json`标志获取结构化输出：

```bash
longto -p "解释这个代码库的架构" --output-format json
```

### 快速示例

#### 启动新项目

```bash
cd new-project/
longto
> 为我写一个Discord机器人，使用我将提供的FAQ.md文件回答问题
```

#### 分析现有代码

```bash
git clone https://github.com/LongToon/LongTo-Cli
cd LongTo-Cli
longto
> 给我总结昨天所有提交的更改
```

#### 使用GLM模型进行中文交互

```bash
# 设置GLM模型
export GLM_MODEL=glm-4.5-flash
export GLM_API_KEY="your_glm_api_key"

# 启动并使用中文交互
longto
> 请帮我分析这个React组件的性能问题
> 写一个Python脚本来处理CSV文件
```

## 📚 文档

### 入门指南

- [**快速入门指南**](./docs/get-started/index.md) - 快速上手
- [**认证设置**](./docs/get-started/authentication.md) - 详细的认证配置
- [**配置指南**](./docs/get-started/configuration.md) - 设置和自定义
- [**键盘快捷键**](./docs/cli/keyboard-shortcuts.md) - 提高效率的技巧

### 核心功能

- [**命令参考**](./docs/cli/commands.md) - 所有斜杠命令
  (`/help`, `/chat` 等)
- [**自定义命令**](./docs/cli/custom-commands.md) - 创建您自己的
  可重用命令
- [**上下文文件 (GEMINI.md)**](./docs/cli/gemini-md.md) - 为LongTo CLI提供
  持久上下文
- [**检查点**](./docs/cli/checkpointing.md) - 保存和恢复对话
- [**令牌缓存**](./docs/cli/token-caching.md) - 优化令牌使用

### 工具与扩展

- [**内置工具概述**](./docs/tools/index.md)
  - [文件系统操作](./docs/tools/file-system.md)
  - [Shell命令](./docs/tools/shell.md)
  - [网络获取与搜索](./docs/tools/web-fetch.md)
- [**MCP服务器集成**](./docs/tools/mcp-server.md) - 使用自定义工具扩展
- [**自定义扩展**](./docs/extensions/index.md) - 构建和共享您自己的命令

### 高级主题

- [**无头模式（脚本）**](./docs/cli/headless.md) - 在自动化工作流中使用LongTo CLI
- [**架构概述**](./docs/architecture.md) - LongTo CLI的工作原理
- [**IDE集成**](./docs/ide-integration/index.md) - VS Code伴侣
- [**沙盒与安全**](./docs/cli/sandbox.md) - 安全执行环境
- [**受信任文件夹**](./docs/cli/trusted-folders.md) - 按文件夹控制执行策略
- [**企业指南**](./docs/cli/enterprise.md) - 在企业环境中部署和管理
- [**遥测与监控**](./docs/cli/telemetry.md) - 使用情况跟踪
- [**工具API开发**](./docs/core/tools-api.md) - 创建自定义工具

### 故障排除与支持

- [**故障排除指南**](./docs/troubleshooting.md) - 常见问题和解决方案
- [**FAQ**](./docs/faq.md) - 常见问题解答
- 使用 `/bug` 命令直接从CLI报告问题

### 使用MCP服务器

在 `~/.gemini/settings.json` 中配置MCP服务器，使用自定义工具扩展LongTo CLI：

```text
> @github 列出我的开放拉取请求
> @slack 将今天的提交摘要发送到#dev频道
> @database 运行查询以查找不活跃用户
```

请参阅[MCP服务器集成指南](./docs/tools/mcp-server.md)获取设置说明。

## 🤝 贡献

我们欢迎贡献！LongTo CLI是完全开源的（Apache 2.0），我们鼓励社区：

- 报告错误和提出功能建议。
- 改进文档。
- 提交代码改进。
- 分享您的MCP服务器和扩展。

请参阅我们的[贡献指南](./CONTRIBUTING.md)了解开发设置、编码标准和如何提交拉取请求。

查看我们的[官方路线图](https://github.com/orgs/LongToon/projects)了解计划功能和优先级。

## 📖 资源

- **[官方路线图](./ROADMAP.md)** - 查看即将推出的功能。
- **[更新日志](./docs/changelogs/index.md)** - 查看最近的重大更新。
- **[NPM包](https://www.npmjs.com/package/@longtoon/longto)** - 包注册表。
- **[GitHub Issues](https://github.com/LongToon/LongTo-Cli/issues)** -
  报告错误或请求功能。
- **[安全公告](https://github.com/LongToon/LongTo-Cli/security/advisories)** -
  安全更新。

### 卸载

请参阅[卸载指南](docs/cli/uninstall.md)了解卸载说明。

## 📄 Legal

- **License**: [Apache License 2.0](LICENSE)
- **Terms of Service**: [Terms & Privacy](./docs/tos-privacy.md)
- **Security**: [Security Policy](SECURITY.md)

---

<p align="center">
  由LongTo团队和开源社区使用❤️构建
</p>