Skip to main content

cc-nano 是一个极简的 AI 编程助手

Project description

cc-nano

cc-nano 是一个极简的 AI 编程助手,旨在帮助您在终端中快速完成软件工程任务。它支持文件编辑、搜索、Git 操作、代码审查、测试运行等常用开发流水线,并内置了有趣的“伙伴”(Buddy)系统和挂机冒险(Idle Adventure)迷你游戏。

✨ 主要特性

  • 交互式 REPL – 直接在终端中与 AI 对话,支持 / 斜杠命令和 ! Shell 命令。
  • 强大的工具集 – 文件读写、全局搜索(Glob)、正则搜索(Grep)、Bash 执行(支持沙箱隔离)。
  • 记忆系统(KAIROS) – 持久化记忆,跨会话回忆重要信息,支持每日日志和梦境整合。
  • 计划模式 – 先探索、设计方案,获得用户批准后再实现代码。
  • 团队协作模式 – 支持 Architect、TechLead、Implementer 等角色,自动拆分任务、生成计划和代码审查。
  • 伙伴系统(Buddy) – 孵化一只随机的 ASCII 艺术宠物,它会根据您的编码活动变化心情,并实时在终端右下角点评。
  • 挂机冒险(Idle Adventure) – 在内置的肉鸽式世界探索游戏中收集徽章,获得抽奖券,解锁稀有伙伴。
  • 成本追踪 – 自动统计 API 调用 token 和费用(支持 DeepSeek V4 定价)。
  • 沙箱隔离 – 使用 bwrap 将 Bash 命令运行在隔离环境中,提升安全性。

🚀 快速安装

# 从 PyPI 安装(推荐)
pip install cc-nano

# 或直接从源码安装
# 从gitee
git clone https://gitee.com/cipologic/cc-nano.git
# 或者从github
git clone https://github.com/cipologic/cc-nano.git
cd cc-nano
pip install -e .

🔧 首次使用

cc-nano 需要一个 API Key 来调用 LLM。您可以通过以下方式配置:

  1. 环境变量

    export OPENAI_API_KEY="your-key-here"
    export OPENAI_BASE_URL="https://api.deepseek.com/v1"   # 可选
    
  2. 项目配置文件
    在项目根目录创建 .cc-nano.toml

  3. 命令行参数

    cc-nano --api-key your-key --provider openai --model deepseek-v4-flash
    

💻 基本使用

启动交互式 REPL:

cc-nano

在提示符下,你可以:

  • 直接提问:例如 “解释 src/main.py 的功能”
  • 使用专用工具:系统会自动调用 ReadGrepEdit 等工具完成任务
  • 执行终端命令:以 ! 开头,例如 ! git status
  • 使用斜杠命令:例如 /help, /plan, /buddy

📖 进阶学习

《学废 cc-nano AI编程》

🧪 开发与贡献

欢迎提 Issue 和 Pull Request!

📜 许可证

本项目采用 MIT 许可证。详见 LICENSE 文件。

Project details


Download files

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

Source Distribution

cc_nano-0.1.0.tar.gz (193.7 kB view details)

Uploaded Source

Built Distribution

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

cc_nano-0.1.0-py3-none-any.whl (235.0 kB view details)

Uploaded Python 3

File details

Details for the file cc_nano-0.1.0.tar.gz.

File metadata

  • Download URL: cc_nano-0.1.0.tar.gz
  • Upload date:
  • Size: 193.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.10.12 Linux/5.15.153.1-microsoft-standard-WSL2

File hashes

Hashes for cc_nano-0.1.0.tar.gz
Algorithm Hash digest
SHA256 482aad0cc9ad961f17464e67395e14bce0990fbbf7ffd1173537b78d47fe145b
MD5 95a24c34863822e53e279fbb76db7101
BLAKE2b-256 e8091b36fc3f0131b3ea6041a5c1c4df804edca8989e52e89070e693cfbb5b08

See more details on using hashes here.

File details

Details for the file cc_nano-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: cc_nano-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 235.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.10.12 Linux/5.15.153.1-microsoft-standard-WSL2

File hashes

Hashes for cc_nano-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 55b206b7b81de69dd1c856a2c8755167d65abdcd0e8cfd18bef1af3b69d5484a
MD5 d7748bd032b0ee21562f320ed1c09683
BLAKE2b-256 e683f6641863a92d644453bdfb4819845ec7ccc6aa3e728f826f26531a0fd10e

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