Skip to content
Closed
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

**✨ Full Documentation**: [ZCF Docs](https://zcf.ufomiao.com/)

> Zero-config, one-click setup for Claude Code & Codex with bilingual support, intelligent agent system and personalized AI assistant
> Zero-config, one-click setup for Claude Code, Codex & CodeBuddy with bilingual support, intelligent agent system and personalized AI assistant
</p>
</div>

Expand All @@ -30,6 +30,7 @@
```bash
npx zcf i # Full initialization: install + workflows + API/CCR + MCP
npx zcf u # Update workflows only
npx zcf i -s -T codebuddy -p 302ai -k "sk-xxx" # Initialize CodeBuddy
npx zcf --lang zh-CN # Switch interface language (example)
```

Expand Down
3 changes: 2 additions & 1 deletion README_ja-JP.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

**✨ 完全ドキュメント**: [ドキュメント入口](https://zcf.ufomiao.com/ja-JP/)

> ゼロ設定、ワンクリックで Claude Code & Codex 環境セットアップ - 多言語設定、インテリジェントプロキシシステム、パーソナライズされたAIアシスタント対応
> ゼロ設定、ワンクリックで Claude CodeCodex、CodeBuddy 環境セットアップ - 多言語設定、インテリジェントプロキシシステム、パーソナライズされたAIアシスタント対応
</p>
</div>

Expand All @@ -30,6 +30,7 @@
```bash
npx zcf i # フル初期化:インストール + ワークフロー + API/CCR + MCP
npx zcf u # ワークフローのみ更新
npx zcf i -s -T codebuddy -p 302ai -k "sk-xxx" # CodeBuddy を初期化
npx zcf --lang ja # インターフェース言語を切り替え(例)
```

Expand Down
3 changes: 2 additions & 1 deletion README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

**✨ 完整文档**: [文档入口](https://zcf.ufomiao.com/zh-CN/)

> 零配置,一键搞定 Claude Code & Codex 环境设置 - 支持中英文双语配置、智能代理系统和个性化 AI 助手
> 零配置,一键搞定 Claude Code、Codex 与 CodeBuddy 环境设置 - 支持中英文双语配置、智能代理系统和个性化 AI 助手
</p>
</div>

Expand All @@ -30,6 +30,7 @@
```bash
npx zcf i # 完整初始化:安装 + 工作流 + API/CCR + MCP
npx zcf u # 仅更新工作流
npx zcf i -s -T codebuddy -p 302ai -k "sk-xxx" # 初始化 CodeBuddy
npx zcf --lang zh-CN # 切换界面语言示例
```

Expand Down
1 change: 1 addition & 0 deletions docs/en/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* [Features Overview](features/index.md)
* [Claude Code Configuration](features/claude-code.md)
* [Codex Support](features/codex.md)
* [CodeBuddy Support](features/codebuddy.md)
* [Workflow System](features/workflows.md)
* [MCP Service Integration](features/mcp.md)
* [Claude Code Router](features/ccr.md)
Expand Down
132 changes: 132 additions & 0 deletions docs/en/features/codebuddy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
---
title: CodeBuddy Support
---

# CodeBuddy Support

[CodeBuddy](https://codebuddy.ai) is an AI coding agent that works through a local configuration directory. ZCF adds CodeBuddy support using the same configuration patterns as Claude Code and Codex, so you can set up or switch to CodeBuddy with a single command.

## Core Features

- **Unified Tool Switching**: Switch between Claude Code, Codex, and CodeBuddy from the ZCF menu or CLI.
- **Profile-Based API Configuration**: Store multiple API profiles and switch between them.
- **MCP Service Integration**: Install and manage MCP servers in `~/.codebuddy/.mcp.json`.
- **Multi-Language Support**: Configure AI output language through `CODEBUDDY.md`.
- **Backup Safety**: MCP configuration changes create timestamped backups.

## Installation and Initialization

### Initialize CodeBuddy

```bash
# Interactive initialization
npx zcf
# Select S (Switch code tool) → CodeBuddy → Full initialization

# Non-interactive initialization
npx zcf i -s -T codebuddy --api-type api_key --api-key "sk-xxx" --api-url "https://api.example.com"
```

### Initialize with a Provider Preset

```bash
npx zcf i -s -T codebuddy -p 302ai -k "sk-xxx"
```

## Configuration Files

ZCF creates the following CodeBuddy configuration structure:

```
~/.codebuddy/
├── settings.json # API keys, base URL, and model env variables
├── .mcp.json # MCP server configurations
├── CODEBUDDY.md # Global memory / language directive
└── backup/ # Timestamped MCP backups
```

### `settings.json` Environment Variables

ZCF writes API configuration to the `env` section of `settings.json`:

| Variable | Description |
|----------|-------------|
| `ANTHROPIC_API_KEY` | API key authentication |
| `ANTHROPIC_AUTH_TOKEN` | Auth token authentication |
| `ANTHROPIC_BASE_URL` | Custom API base URL |
| `ANTHROPIC_MODEL` | Primary model |
| `ANTHROPIC_DEFAULT_HAIKU_MODEL` | Default Haiku model |
| `ANTHROPIC_DEFAULT_SONNET_MODEL` | Default Sonnet model |
| `ANTHROPIC_DEFAULT_OPUS_MODEL` | Default Opus model |

## MCP Service Integration

CodeBuddy uses the same MCP services as Claude Code and Codex:

```bash
# Install MCP services non-interactively
npx zcf i -s -T codebuddy --mcp-services all

# Selective installation
npx zcf i -s -T codebuddy --mcp-services context7,exa

# Configure through menu
npx zcf → CodeBuddy → Configure MCP
```

MCP servers are saved in `~/.codebuddy/.mcp.json`.

## Multi-Provider Configuration

You can define multiple API profiles for CodeBuddy:

```bash
npx zcf i -s -T codebuddy --api-configs '[
{"provider":"302ai","key":"sk-xxx","default":true},
{"name":"custom","type":"api_key","key":"sk-yyy","url":"https://custom.api.com"}
]'
```

Switch profiles interactively:

```bash
npx zcf config-switch -T codebuddy
```

## Common Operations

### Update CodeBuddy Configuration

```bash
npx zcf update -T codebuddy
```

### Check for Updates

```bash
npx zcf check-updates -T codebuddy
```

### Uninstall CodeBuddy

```bash
npx zcf uninstall -T codebuddy
```

This removes the MCP configuration and clears API keys from `settings.json`.

## Comparison with Claude Code and Codex

| Feature | Claude Code | Codex | CodeBuddy |
|---------|------------|-------|-----------|
| Configuration file | `~/.claude/settings.json` | `~/.codex/config.toml` | `~/.codebuddy/settings.json` |
| Memory file | `CLAUDE.md` | `AGENTS.md` | `CODEBUDDY.md` |
| MCP config | `.claude.json` / `settings.json` | `config.toml` | `.mcp.json` |
| API configuration | Auth token / API key / CCR proxy | Provider + API key | Auth token / API key |
| Multi-provider | ✅ | ✅ | ✅ |

## Notes

- CodeBuddy support is currently adapter-based: ZCF manages the configuration files, while CodeBuddy reads them at runtime.
- When switching away from CodeBuddy, ZCF sets the active code tool back to `claude-code` by default.
- The menu system currently routes CodeBuddy through a dedicated set of options; if you notice missing menu actions, please report them.
1 change: 1 addition & 0 deletions docs/ja-JP/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* [機能概要](features/index.md)
* [Claude Code 設定機能](features/claude-code.md)
* [Codex サポート](features/codex.md)
* [CodeBuddy サポート](features/codebuddy.md)
* [ワークフローシステム](features/workflows.md)
* [MCP サービス統合](features/mcp.md)
* [Claude Code Router](features/ccr.md)
Expand Down
132 changes: 132 additions & 0 deletions docs/ja-JP/features/codebuddy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
---
title: CodeBuddy サポート
---

# CodeBuddy サポート

[CodeBuddy](https://codebuddy.ai) は、ローカルの設定ディレクトリを通じて動作する AI コーディングエージェントです。ZCF は Claude Code や Codex と同じ設定パターンを使用して CodeBuddy サポートを追加し、1 つのコマンドで CodeBuddy のセットアップや切り替えを行えます。

## 主な機能

- **統合ツール切り替え**: ZCF メニューまたは CLI から Claude Code、Codex、CodeBuddy を切り替え
- **プロファイルベースの API 設定**: 複数の API プロファイルを保存して切り替え
- **MCP サービス統合**: `~/.codebuddy/.mcp.json` で MCP サーバーのインストールと管理
- **多言語対応**: `CODEBUDDY.md` で AI 出力言語を設定
- **バックアップ安全性**: MCP 設定変更時にタイムスタンプ付きバックアップを作成

## インストールと初期化

### CodeBuddy を初期化

```bash
# 対話式初期化
npx zcf
# S(コードツールを切り替え)→ CodeBuddy → 完全初期化 を選択

# 非対話式初期化
npx zcf i -s -T codebuddy --api-type api_key --api-key "sk-xxx" --api-url "https://api.example.com"
```

### プロバイダープリセットを使用して初期化

```bash
npx zcf i -s -T codebuddy -p 302ai -k "sk-xxx"
```

## 設定ファイル

ZCF は以下の CodeBuddy 設定構造を作成します:

```
~/.codebuddy/
├── settings.json # API キー、ベース URL、モデル環境変数
├── .mcp.json # MCP サーバー設定
├── CODEBUDDY.md # グローバルメモリ / 言語指令
└── backup/ # タイムスタンプ付き MCP バックアップ
```

### `settings.json` 環境変数

ZCF は API 設定を `settings.json` の `env` セクションに書き込みます:

| 変数 | 説明 |
|------|------|
| `ANTHROPIC_API_KEY` | API キー認証 |
| `ANTHROPIC_AUTH_TOKEN` | 認証トークン |
| `ANTHROPIC_BASE_URL` | カスタム API ベース URL |
| `ANTHROPIC_MODEL` | プライマリモデル |
| `ANTHROPIC_DEFAULT_HAIKU_MODEL` | デフォルト Haiku モデル |
| `ANTHROPIC_DEFAULT_SONNET_MODEL` | デフォルト Sonnet モデル |
| `ANTHROPIC_DEFAULT_OPUS_MODEL` | デフォルト Opus モデル |

## MCP サービス統合

CodeBuddy は Claude Code および Codex と同じ MCP サービスを使用します:

```bash
# すべての MCP サービスを非対話式でインストール
npx zcf i -s -T codebuddy --mcp-services all

# 選択的インストール
npx zcf i -s -T codebuddy --mcp-services context7,exa

# メニューから設定
npx zcf → CodeBuddy → MCP の設定
```

MCP サーバーは `~/.codebuddy/.mcp.json` に保存されます。

## マルチプロバイダー設定

CodeBuddy 用に複数の API プロファイルを定義できます:

```bash
npx zcf i -s -T codebuddy --api-configs '[
{"provider":"302ai","key":"sk-xxx","default":true},
{"name":"custom","type":"api_key","key":"sk-yyy","url":"https://custom.api.com"}
]'
```

対話式にプロファイルを切り替え:

```bash
npx zcf config-switch -T codebuddy
```

## よく使う操作

### CodeBuddy 設定を更新

```bash
npx zcf update -T codebuddy
```

### 更新を確認

```bash
npx zcf check-updates -T codebuddy
```

### CodeBuddy をアンインストール

```bash
npx zcf uninstall -T codebuddy
```

アンインストールは MCP 設定を削除し、`settings.json` から API キーをクリアします。

## Claude Code および Codex との比較

| 機能 | Claude Code | Codex | CodeBuddy |
|------|------------|-------|-----------|
| 設定ファイル | `~/.claude/settings.json` | `~/.codex/config.toml` | `~/.codebuddy/settings.json` |
| メモリファイル | `CLAUDE.md` | `AGENTS.md` | `CODEBUDDY.md` |
| MCP 設定 | `.claude.json` / `settings.json` | `config.toml` | `.mcp.json` |
| API 設定 | 認証トークン / API キー / CCR プロキシ | プロバイダー + API キー | 認証トークン / API キー |
| マルチプロバイダー | ✅ | ✅ | ✅ |

## 備考

- CodeBuddy サポートは現在アダプターベースです:ZCF が設定ファイルを管理し、CodeBuddy が実行時に読み取ります。
- CodeBuddy から切り替える際、ZCF はデフォルトで現在のツールを `claude-code` に戻します。
- メニューシステムには CodeBuddy 専用のオプションが用意されています。不足しているメニュー操作があればフィードバックしてください。
1 change: 1 addition & 0 deletions docs/zh-CN/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* [功能总览](features/index.md)
* [Claude Code 配置能力](features/claude-code.md)
* [Codex 支持](features/codex.md)
* [CodeBuddy 支持](features/codebuddy.md)
* [工作流系统](features/workflows.md)
* [MCP 服务集成](features/mcp.md)
* [Claude Code Router](features/ccr.md)
Expand Down
Loading
Loading