From 47c87ec7c2a88ff483d366e63685aee4573d64dd Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:43:26 +0000 Subject: [PATCH] docs: make Chinese README the default --- README.md | 474 +++++++++++++++++++++++++++--------------------------- 1 file changed, 240 insertions(+), 234 deletions(-) diff --git a/README.md b/README.md index be6a66a..578cdcf 100644 --- a/README.md +++ b/README.md @@ -1,234 +1,240 @@ -

- - - - - - -
-

-
- -
- -

- - - 30-Second Install - - · - - Website - - · - - Docs - - · - - Examples - - · - - Local Self-Hosted Mode - -

- -
- -[![Discord](https://img.shields.io/discord/1214825831973785600.svg?style=flat&logo=discord&label=Discord&refresh=1)](https://discord.gg/plandex-ai) -[![GitHub Repo stars](https://img.shields.io/github/stars/plandex-ai/plandex?style=social)](https://github.com/plandex-ai/plandex) -[![Twitter Follow](https://img.shields.io/twitter/follow/PlandexAI?style=social)](https://twitter.com/PlandexAI) - -
- -

- -PRs Welcome Release -Release - - - -

- -
- -
-plandex-ai%2Fplandex | Trendshift -
- -
- -

- An AI coding agent designed for large tasks and real world projects.

-

- - -
- -
- - Plandex v2 Demo Video - -
- -
- -💻  Plandex is a terminal-based AI development tool that can **plan and execute** large coding tasks that span many steps and touch dozens of files. It can handle up to 2M tokens of context directly (~100k per file), and can index directories with 20M tokens or more using tree-sitter project maps. - -🔬  **A cumulative diff review sandbox** keeps AI-generated changes separate from your project files until they are ready to go. Command execution is controlled so you can easily roll back and debug. Plandex helps you get the most out of AI without leaving behind a mess in your project. - -🧠  **Combine the best models** from Anthropic, OpenAI, Google, and open source providers to build entire features and apps with a robust terminal-based workflow. - -🚀  Plandex is capable of full autonomy—it can load relevant files, plan and implement changes, execute commands, and automatically debug—but it's also highly flexible and configurable, giving developers fine-grained control and a step-by-step review process when needed. - -💪  Plandex is designed to be resilient to large projects and files. If you've found that others tools struggle once your project gets past a certain size or the changes are too complex, give Plandex a shot. - -## Smart context management that works in big projects - -- 🐘 **2M token effective context window** with default model pack. Plandex loads only what's needed for each step. - -- 🗄️ **Reliable in large projects and files.** Easily generate, review, revise, and apply changes spanning dozens of files. - -- 🗺️ **Fast project map generation** and syntax validation with tree-sitter. Supports 30+ languages. - -- 💰 **Context caching** is used across the board for OpenAI, Anthropic, and Google models, reducing costs and latency. - -## Tight control or full autonomy—it's up to you - -- 🚦 **Configurable autonomy:** go from full auto mode to fine-grained control depending on the task. - -- 🐞 **Automated debugging** of terminal commands (like builds, linters, tests, deployments, and scripts). If you have Chrome installed, you can also automatically debug browser applications. - -## Tools that help you get production-ready results - -- 💬 **A project-aware chat mode** that helps you flesh out ideas before moving to implementation. Also great for asking questions and learning about a codebase. - -- 🧠 **Easily try + combine models** from multiple providers. Curated model packs offer different tradeoffs of capability, cost, and speed, as well as open source and provider-specific packs. - -- 🛡️ **Reliable file edits** that prioritize correctness. While most edits are quick and cheap, Plandex validates both syntax and logic as needed, with multiple fallback layers when there are problems. - -- 🔀 **Full-fledged version control** for every update to the plan, including branches for exploring multiple paths or comparing different models. - -- 📂 **Git integration** with commit message generation and optional automatic commits. - -## Dev-friendly, easy to install - -- 🧑‍💻 **REPL mode** with fuzzy auto-complete for commands and file loading. Just run `plandex` in any project to get started. - -- 🛠️ **CLI interface** for scripting or piping data into context. - -- 📦 **One-line, zero dependency CLI install**. Dockerized local mode for easily self-hosting the server. Cloud-hosting options for extra reliability and convenience. - -## Workflow  🔄 - -Plandex workflow - -## Examples  🎥 - -
- -
- - Plandex Browser Debugging Example - -
- -
- -## Install  📥 - -```bash -curl -sL https://plandex.ai/install.sh | bash -``` - -**Note:** Windows is supported via [WSL](https://learn.microsoft.com/en-us/windows/wsl/install). Plandex only works correctly on Windows in the WSL shell. It doesn't work in the Windows CMD prompt or PowerShell. - -[More installation options.](https://docs.plandex.ai/install) - -## Hosting  ⚖️ - -| Option | Description | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Plandex Cloud** | Winding down as of 10/3/2025 and no longer accepting new users. Learn more. | -| **Self-hosted/Local Mode** | • Run Plandex locally with Docker or host on your own server.
• Use your own [OpenRouter.ai](https://openrouter.ai) key (or [other model provider](https://docs.plandex.ai/models/model-providers) accounts and API keys).
• Follow the [local-mode quickstart](https://docs.plandex.ai/hosting/self-hosting/local-mode-quickstart) to get started. | - -## Provider keys  🔑 - - - -```bash -export OPENROUTER_API_KEY=... # if using OpenRouter.ai -``` - -
- -## Claude Pro/Max subscription  🖇️ - -If you have a Claude Pro or Max subscription, Plandex can use it when calling Anthropic models. You'll be asked if you want to connect a subscription the first time you run Plandex. - -
- -## Get started  🚀 - -First, `cd` into a **project directory** where you want to get something done or chat about the project. Make a new directory first with `mkdir your-project-dir` if you're starting on a new project. - -```bash -cd your-project-dir -``` - -For a new project, you might also want to initialize a git repo. Plandex doesn't require that your project is in a git repo, but it does integrate well with git if you use it. - -```bash -git init -``` - -Now start the Plandex REPL in your project: - -```bash -plandex -``` - -or for short: - -```bash -pdx -``` - - - -
- -## Docs  🛠️ - -### [👉  Full documentation.](https://docs.plandex.ai/) - -
- -## Discussion and discord  💬 - -Please feel free to give your feedback, ask questions, report a bug, or just hang out: - -- [Discord](https://discord.gg/plandex-ai) -- [Discussions](https://github.com/plandex-ai/plandex/discussions) -- [Issues](https://github.com/plandex-ai/plandex/issues) - -## Follow and subscribe - -- [Follow @PlandexAI](https://x.com/PlandexAI) -- [Follow @Danenania](https://x.com/Danenania) (Plandex's creator) -- [Subscribe on YouTube](https://x.com/PlandexAI) - -
- -## Contributors  👥 - -⭐️  Please star, fork, explore, and contribute to Plandex. There's a lot of work to do and so much that can be improved. - -[Here's an overview on setting up a development environment.](https://docs.plandex.ai/development) + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/plandex-ai/plandex) · [上游 README](https://github.com/plandex-ai/plandex/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 + +

+ + + + + + +
+

+
+ +
+ +

+ + + 30 秒安装 + + · + + 官网 + + · + + 文档 + + · + + 示例 + + · + + 本地自托管模式 + +

+ +
+ +[![Discord](https://img.shields.io/discord/1214825831973785600.svg?style=flat&logo=discord&label=Discord&refresh=1)](https://discord.gg/plandex-ai) +[![GitHub Repo stars](https://img.shields.io/github/stars/plandex-ai/plandex?style=social)](https://github.com/plandex-ai/plandex) +[![Twitter Follow](https://img.shields.io/twitter/follow/PlandexAI?style=social)](https://twitter.com/PlandexAI) + +
+ +

+ +PRs Welcome Release +Release + + + +

+ +
+ +
+plandex-ai%2Fplandex | Trendshift +
+ +
+ +

+ 专为大型任务和真实世界项目设计的 AI 编程代理（agent）。

+

+ + +
+ +
+ + Plandex v2 演示视频 + +
+ +
+ +💻  Plandex 是一款基于终端的 AI 开发工具，能够**规划并执行**跨越多个步骤、涉及数十个文件的大型编码任务。它可直接处理多达 200 万 token 的上下文（每个文件约 10 万），并可通过 tree-sitter 项目地图（project map）为包含 2000 万 token 或更多的目录建立索引。 + +🔬  **累积 diff 审查沙箱（sandbox）** 会将 AI 生成的变更与项目文件隔离，直到你确认可以合并。命令执行受到管控，便于你轻松回滚和调试。Plandex 帮助你充分发挥 AI 的潜力，同时避免在项目里留下一团糟。 + +🧠  **组合多家顶尖模型**：来自 Anthropic、OpenAI、Google 以及开源提供商的模型，通过稳健的终端工作流构建完整功能与应用。 + +🚀  Plandex 具备完全自主能力——可加载相关文件、规划并实现变更、执行命令并自动调试——同时也高度灵活、可配置，在需要时让开发者获得细粒度控制和逐步审查流程。 + +💪  Plandex 针对大型项目与大型文件做了韧性设计。若你发现其他工具在项目超过一定规模或变更过于复杂时就力不从心，不妨试试 Plandex。 + +## 适用于大型项目的智能上下文管理 + +- 🐘 **200 万 token 有效上下文窗口**：使用默认模型包（model pack）时，Plandex 每步仅加载所需内容。 + +- 🗄️ **在大型项目与大型文件中依然可靠。** 轻松生成、审查、修订并应用跨越数十个文件的变更。 + +- 🗺️ **快速生成项目地图**并通过 tree-sitter 进行语法校验。支持 30+ 种语言。 + +- 💰 **上下文缓存（context caching）** 全面用于 OpenAI、Anthropic 和 Google 模型，降低成本与延迟。 + +## 严密掌控或完全自主——由你决定 + +- 🚦 **可配置自主性：** 根据任务在全自动模式与细粒度控制之间切换。 + +- 🐞 **终端命令自动调试**（如构建、linter、测试、部署和脚本）。若已安装 Chrome，还可自动调试浏览器应用。 + +## 助你产出可上线成果的工具 + +- 💬 **项目感知聊天模式**，在动手实现前帮你完善想法；也适合提问和了解代码库。 + +- 🧠 **轻松试用并组合多家提供商的模型**。精选模型包在能力、成本与速度之间提供不同权衡，另有开源及厂商专属包。 + +- 🛡️ **可靠的文件编辑**，优先保证正确性。多数编辑快速且低成本，必要时 Plandex 会校验语法与逻辑，并在出问题时提供多层回退。 + +- 🔀 **完善的版本控制**，覆盖计划的每次更新，包括用于探索多条路径或对比不同模型的分支。 + +- 📂 **Git 集成**，支持生成提交信息及可选的自动提交。 + +## 开发者友好，安装简单 + +- 🧑‍💻 **REPL 模式**，为命令与文件加载提供模糊自动补全。在任何项目中运行 `plandex` 即可开始。 + +- 🛠️ **CLI 界面**，便于脚本化或将数据管道输入上下文。 + +- 📦 **一行命令、零依赖 CLI 安装**。Docker 化本地模式便于自托管服务器。另有云托管选项，提升可靠性与便利性。 + +## 工作流  🔄 + +Plandex 工作流 + +## 示例  🎥 + +
+ +
+ + Plandex 浏览器调试示例 + +
+ +
+ +## 安装  📥 + +```bash +curl -sL https://plandex.ai/install.sh | bash +``` + +**注意：** Windows 通过 [WSL](https://learn.microsoft.com/en-us/windows/wsl/install). 支持；Plandex 仅在 WSL shell 中能在 Windows 上正常工作。它无法在 Windows CMD 提示符或 PowerShell 中运行。 + +[更多安装选项。](https://docs.plandex.ai/install) + +## 托管  ⚖️ + +| 选项 | 说明 | +| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Plandex Cloud** | 自 2025 年 10 月 3 日起逐步关停，不再接受新用户。了解更多。 | +| **自托管/本地模式** | • 使用 Docker 在本地运行 Plandex，或部署在你自己的服务器上。
• 使用你自己的 [OpenRouter.ai](https://openrouter.ai) 密钥（或[其他模型提供商](https://docs.plandex.ai/models/model-providers) 账户与 API 密钥）。
• 按照[本地模式快速入门](https://docs.plandex.ai/hosting/self-hosting/local-mode-quickstart) 开始操作。 | + +## Provider keys 🔑 + + + +```bash +export OPENROUTER_API_KEY=... # 若使用 OpenRouter.ai +``` + +
+ +## Claude Pro/Max subscription 🖇️ + +若你拥有 Claude Pro 或 Max 订阅，Plandex 在调用 Anthropic 模型时可以使用该订阅。首次运行 Plandex 时，系统会询问你是否要连接订阅。 + +
+ +## Get started 🚀 + +首先，在你想要完成任务或与项目交流的 **项目目录（project directory）** 中执行 `cd`。若你正在启动一个新项目，请先用 `mkdir your-project-dir` 创建新目录。 + +```bash +cd your-project-dir +``` + +对于新项目，你可能还想初始化一个 git 仓库。Plandex 不要求项目必须位于 git 仓库中，但如果你使用 git，它能很好地与之集成。 + +```bash +git init +``` + +现在在你的项目中启动 Plandex REPL： + +```bash +plandex +``` + +或简写为： + +```bash +pdx +``` + + + +
+ +## Docs 🛠️ + +### [👉 完整文档。](https://docs.plandex.ai/) + +
+ +## Discussion and discord 💬 + +欢迎随时提供反馈、提问、报告 bug，或只是来聊聊天： + +- [Discord](https://discord.gg/plandex-ai) +- [Discussions](https://github.com/plandex-ai/plandex/discussions) +- [Issues](https://github.com/plandex-ai/plandex/issues) + +## Follow and subscribe + +- [Follow @PlandexAI](https://x.com/PlandexAI) +- [Follow @Danenania](https://x.com/Danenania)（Plandex 的创作者） +- [Subscribe on YouTube](https://x.com/PlandexAI) + +
+ +## Contributors 👥 + +⭐️ 欢迎为 Plandex star、fork、探索并贡献代码。还有很多工作要做，也有许多可以改进之处。 + +[这是搭建开发环境的概览。](https://docs.plandex.ai/development)