Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions .codebuddy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# Everything Claude Code for CodeBuddy

Bring Everything Claude Code (ECC) workflows to CodeBuddy IDE. This repository provides custom commands, agents, skills, and rules that can be installed into any CodeBuddy project using the unified Target Adapter architecture.

## Quick Start (Recommended)

Use the unified install system for full lifecycle management:

```bash
# Install with default profile
node scripts/install-apply.js --target codebuddy --profile developer

# Install with full profile (all modules)
node scripts/install-apply.js --target codebuddy --profile full

# Dry-run to preview changes
node scripts/install-apply.js --target codebuddy --profile full --dry-run
```

## Management Commands

```bash
# Check installation health
node scripts/doctor.js --target codebuddy

# Repair installation
node scripts/repair.js --target codebuddy

# Uninstall cleanly (tracked via install-state)
node scripts/uninstall.js --target codebuddy
```

## Shell Script (Legacy)

The legacy shell scripts are still available for quick setup:

```bash
# Install to current project
cd /path/to/your/project
.codebuddy/install.sh

# Install globally
.codebuddy/install.sh ~
```

## What's Included

### Commands

Commands are on-demand workflows invocable via the `/` menu in CodeBuddy chat. All commands are reused directly from the project root's `commands/` folder.

### Agents

Agents are specialized AI assistants with specific tool configurations. All agents are reused directly from the project root's `agents/` folder.

### Skills

Skills are on-demand workflows invocable via the `/` menu in chat. All skills are reused directly from the project's `skills/` folder.

### Rules

Rules provide always-on rules and context that shape how the agent works with your code. Rules are flattened into namespaced files (e.g., `common-coding-style.md`) for CodeBuddy compatibility.

## Project Structure

```
.codebuddy/
├── commands/ # Command files (reused from project root)
├── agents/ # Agent files (reused from project root)
├── skills/ # Skill files (reused from skills/)
├── rules/ # Rule files (flattened from rules/)
├── ecc-install-state.json # Install state tracking
├── install.sh # Legacy install script
├── uninstall.sh # Legacy uninstall script
└── README.md # This file
```

## Benefits of Target Adapter Install

- **Install-state tracking**: Safe uninstall that only removes ECC-managed files
- **Doctor checks**: Verify installation health and detect drift
- **Repair**: Auto-fix broken installations
- **Selective install**: Choose specific modules via profiles
- **Cross-platform**: Node.js-based, works on Windows/macOS/Linux

## Recommended Workflow

1. **Start with planning**: Use `/plan` command to break down complex features
2. **Write tests first**: Invoke `/tdd` command before implementing
3. **Review your code**: Use `/code-review` after writing code
4. **Check security**: Use `/code-review` again for auth, API endpoints, or sensitive data handling
5. **Fix build errors**: Use `/build-fix` if there are build errors

## Next Steps

- Open your project in CodeBuddy
- Type `/` to see available commands
- Enjoy the ECC workflows!
98 changes: 98 additions & 0 deletions .codebuddy/README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# Everything Claude Code for CodeBuddy

为 CodeBuddy IDE 带来 Everything Claude Code (ECC) 工作流。此仓库提供自定义命令、智能体、技能和规则,可以通过统一的 Target Adapter 架构安装到任何 CodeBuddy 项目中。

## 快速开始(推荐)

使用统一安装系统,获得完整的生命周期管理:

```bash
# 使用默认配置安装
node scripts/install-apply.js --target codebuddy --profile developer

# 使用完整配置安装(所有模块)
node scripts/install-apply.js --target codebuddy --profile full

# 预览模式查看变更
node scripts/install-apply.js --target codebuddy --profile full --dry-run
```

## 管理命令

```bash
# 检查安装健康状态
node scripts/doctor.js --target codebuddy

# 修复安装
node scripts/repair.js --target codebuddy

# 清洁卸载(通过 install-state 跟踪)
node scripts/uninstall.js --target codebuddy
```

## Shell 脚本(旧版)

旧版 Shell 脚本仍然可用于快速设置:

```bash
# 安装到当前项目
cd /path/to/your/project
.codebuddy/install.sh

# 全局安装
.codebuddy/install.sh ~
```

## 包含的内容

### 命令

命令是通过 CodeBuddy 聊天中的 `/` 菜单调用的按需工作流。所有命令都直接复用自项目根目录的 `commands/` 文件夹。

### 智能体

智能体是具有特定工具配置的专门 AI 助手。所有智能体都直接复用自项目根目录的 `agents/` 文件夹。

### 技能

技能是通过聊天中的 `/` 菜单调用的按需工作流。所有技能都直接复用自项目的 `skills/` 文件夹。

### 规则

规则提供始终适用的规则和上下文,塑造智能体处理代码的方式。规则会被扁平化为命名空间文件(如 `common-coding-style.md`)以兼容 CodeBuddy。

## 项目结构

```
.codebuddy/
├── commands/ # 命令文件(复用自项目根目录)
├── agents/ # 智能体文件(复用自项目根目录)
├── skills/ # 技能文件(复用自 skills/)
├── rules/ # 规则文件(从 rules/ 扁平化)
├── ecc-install-state.json # 安装状态跟踪
├── install.sh # 旧版安装脚本
├── uninstall.sh # 旧版卸载脚本
└── README.md # 此文件
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
```

## Target Adapter 安装的优势

- **安装状态跟踪**:安全卸载,仅删除 ECC 管理的文件
- **Doctor 检查**:验证安装健康状态并检测偏移
- **修复**:自动修复损坏的安装
- **选择性安装**:通过配置文件选择特定模块
- **跨平台**:基于 Node.js,支持 Windows/macOS/Linux

## 推荐的工作流

1. **从计划开始**:使用 `/plan` 命令分解复杂功能
2. **先写测试**:在实现之前调用 `/tdd` 命令
3. **审查您的代码**:编写代码后使用 `/code-review`
4. **检查安全性**:对于身份验证、API 端点或敏感数据处理,再次使用 `/code-review`
5. **修复构建错误**:如果有构建错误,使用 `/build-fix`

## 下一步

- 在 CodeBuddy 中打开您的项目
- 输入 `/` 以查看可用命令
- 享受 ECC 工作流!
Loading