Skip to main content

AutoCoder: AutoCoder

Project description

auto-coder

Auto-Coder (powered by Byzer-LLM)

中文 |


Latest News 🔥

  • [2026/04-demo] Auto-Coder 教程视频录制演示
  • [2025/01] Release Auto-Coder 0.1.208
  • [2024/09] Release Auto-Coder 0.1.163
  • [2024/08] Release Auto-Coder 0.1.143
  • [2024/07] Release Auto-Coder 0.1.115
  • [2024/06] Release Auto-Coder 0.1.82
  • [2024/05] Release Auto-Coder 0.1.73
  • [2024/04] Release Auto-Coder 0.1.46
  • [2024/03] Release Auto-Coder 0.1.25
  • [2024/03] Release Auto-Coder 0.1.24

安装

方法一:使用 pip 安装(推荐)

# 创建虚拟环境(推荐)
conda create --name autocoder python=3.10.11
conda activate autocoder

# 或者使用 venv
python -m venv autocoder
source autocoder/bin/activate  # Linux/macOS
# autocoder\Scripts\activate  # Windows

# 安装 auto-coder
pip install -U auto-coder

方法二:从源码安装

# 克隆仓库
git clone https://github.com/allwefantasy/auto-coder.git
cd auto-coder

# 创建虚拟环境
conda create --name autocoder python=3.10.11
conda activate autocoder

# 安装依赖
pip install -r requirements.txt

# 安装项目
pip install -e .

系统要求

  • Python 3.10, 3.11 或 3.12
  • 操作系统:Windows、macOS、Linux
  • 内存:建议 4GB 以上
  • 磁盘空间:建议 2GB 以上

验证安装

安装完成后,可以通过以下命令验证安装是否成功:

# 检查版本
auto-coder --version

# 启动聊天模式
auto-coder.chat

# 运行单次命令
auto-coder.run -p "Hello, Auto-Coder!"

使用指南

1. 聊天模式(推荐新手使用)

# 启动交互式聊天界面
auto-coder.chat

聊天模式提供友好的交互界面,支持:

  • 实时对话
  • 代码生成和修改
  • 文件操作
  • 项目管理

2. 命令行模式

单次运行模式

# 基本用法
auto-coder.run -p "编写一个计算斐波那契数列的函数"

# 从管道读取输入
echo "解释这段代码的功能" | auto-coder.run -p

# 指定输出格式
auto-coder.run -p "生成一个 Hello World 函数" --output-format json

# 使用详细输出
auto-coder.run -p "创建一个简单的网页" --verbose

会话模式

# 继续最近的对话
auto-coder.run --continue

# 恢复特定会话
auto-coder.run --resume 550e8400-e29b-41d4-a716-446655440000

高级选项

# 限制对话轮数
auto-coder.run -p "优化这个算法" --max-turns 5

# 指定系统提示
auto-coder.run -p "写代码" --system-prompt "你是一个专业的Python开发者"

# 限制可用工具
auto-coder.run -p "读取文件内容" --allowed-tools read_file write_to_file

# 设置权限模式
auto-coder.run -p "修改代码" --permission-mode acceptEdits

3. 核心模式

# 启动核心模式(传统命令行界面)
auto-coder

# 或者使用别名
auto-coder.core

4. 服务器模式

# 启动 Web 服务器
auto-coder.serve

# 或者使用别名
auto-coder-serve

5. RAG 模式

# 启动 RAG(检索增强生成)模式
auto-coder.rag

常用命令示例

# 代码生成
auto-coder.run -p "创建一个 Flask Web 应用"

# 代码解释
auto-coder.run -p "解释这个函数的作用" < code.py

# 代码重构
auto-coder.run -p "重构这段代码,提高可读性"

# 错误修复
auto-coder.run -p "修复这个 bug" --verbose

# 文档生成
auto-coder.run -p "为这个项目生成 README 文档"

# 测试生成
auto-coder.run -p "为这个函数编写单元测试"

自动补全

Auto-Coder 支持命令行自动补全功能:

# 安装自动补全(bash)
echo 'eval "$(register-python-argcomplete auto-coder.run)"' >> ~/.bashrc
source ~/.bashrc

# 安装自动补全(zsh)
echo 'eval "$(register-python-argcomplete auto-coder.run)"' >> ~/.zshrc
source ~/.zshrc

卸载

完全卸载

# 卸载 auto-coder
pip uninstall auto-coder

# 删除虚拟环境(如果使用了虚拟环境)
conda remove --name autocoder --all
# 或者
rm -rf autocoder  # 如果使用 venv 创建的环境

# 清理缓存文件(可选)
rm -rf ~/.autocoder  # 用户配置和缓存目录

重新安装

# 卸载旧版本
pip uninstall auto-coder

# 清理缓存
pip cache purge

# 安装最新版本
pip install -U auto-coder

配置

环境变量

# 设置 API 密钥
export OPENAI_API_KEY="your-api-key"
export ANTHROPIC_API_KEY="your-api-key"

# 设置模型配置
export AUTOCODER_MODEL="gpt-4"
export AUTOCODER_BASE_URL="https://api.openai.com/v1"

配置文件

Auto-Coder 支持多种配置方式:

  • .autocoderrc:项目级配置
  • ~/.autocoder/config.yaml:用户级配置
  • 环境变量:系统级配置

故障排除

常见问题

  1. 安装失败

    # 升级 pip
    pip install --upgrade pip
    
    # 清理缓存重新安装
    pip cache purge
    pip install auto-coder
    
  2. 权限错误

    # 使用用户安装
    pip install --user auto-coder
    
  3. 依赖冲突

    # 使用虚拟环境
    python -m venv autocoder_env
    source autocoder_env/bin/activate
    pip install auto-coder
    
  4. 命令未找到

    # 检查 PATH
    echo $PATH
    
    # 重新安装
    pip uninstall auto-coder
    pip install auto-coder
    

获取帮助

# 查看帮助信息
auto-coder.run --help

# 查看版本信息
auto-coder --version

# 启用详细输出进行调试
auto-coder.run -p "test" --verbose

教程

  1. Auto-Coder.Chat: 通向智能编程之路

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

auto_coder-3.0.51.tar.gz (3.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

auto_coder-3.0.51-py3-none-any.whl (4.6 MB view details)

Uploaded Python 3

File details

Details for the file auto_coder-3.0.51.tar.gz.

File metadata

  • Download URL: auto_coder-3.0.51.tar.gz
  • Upload date:
  • Size: 3.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for auto_coder-3.0.51.tar.gz
Algorithm Hash digest
SHA256 1420d8f50ed93b0f1f5c5d2d0f179eec6b99705203c34f69b43345049bc32639
MD5 ecf47a899460fea08eff1f8624750060
BLAKE2b-256 3738313e6d42e39488caa1a54e4d05296f6a1a1aa08882588a450fe314112bae

See more details on using hashes here.

File details

Details for the file auto_coder-3.0.51-py3-none-any.whl.

File metadata

  • Download URL: auto_coder-3.0.51-py3-none-any.whl
  • Upload date:
  • Size: 4.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for auto_coder-3.0.51-py3-none-any.whl
Algorithm Hash digest
SHA256 dedbd468865598d12e86909bdd796b861b3382a96a803205f0a3c6ec01d063c7
MD5 c61263a64dee0acecfd74fcadadb55f7
BLAKE2b-256 0403c6f4a5c678e29671a1e0093b363e5594b7a20962b1d057e404fcf73fc80c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page