code2prompt

环境要求

• Cargo 与 Rust 工具链（使用 cargo 安装方式时需要）
• Homebrew 包管理器（使用 brew 安装方式时需要）
• Python 与 pip 环境（使用 SDK 安装方式时需要）
• 可访问 crates.io / PyPI 的网络环境

安装与启动步骤

1. 1用 Cargo 安装

   已安装 Rust 与 Cargo 时，直接通过 cargo 从 crates.io 安装 code2prompt 可执行文件。

   cargo install code2prompt

   复制

2. 2启用 Wayland 支持

   在 Wayland 桌面环境下需要剪贴板集成时，安装时加上 wayland feature flag。

   cargo install --features wayland code2prompt

   复制

3. 3用 Homebrew 安装

   macOS 或 Linux 上已装 Homebrew 时，可用 brew 一条命令完成安装。

   brew install code2prompt

   复制

4. 4安装 Python SDK

   想在 Python 项目中调用 code2prompt 能力时，安装官方 pip 包 code2prompt-rs。

   pip install code2prompt-rs

   复制

5. 5生成提示词

   把工具指向代码库目录，默认将生成的提示词输出到 stdout（终端）。注意最后一个点表示当前目录。

   code2prompt .

   复制

6. 6保存为文件

   将生成的提示词写入指定文件，便于后续粘贴或上传给 LLM。路径与文件名可自行替换。

   code2prompt path/to/project --output-file prompt.txt

   复制

关键配置

如何确认成功

执行 code2prompt . 后，终端能打印出由代码库内容构成的提示词文本，即表示安装与运行成功。

常见问题

注意事项

• README 未给出可执行文件的安装路径、默认端口等细节，请以官方文档为准。
• 命令中的 path/to/project、prompt.txt 为示例路径与文件名，请替换成自己的真实值。
• 若使用 Wayland 且需要剪贴板功能，必须带 wayland feature flag 安装，否则 -c 复制可能不可用。