8000 ECC/.trae/README.md at main · AdnanAhmed14/ECC · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 

History

History
184 lines (122 loc) · 5.26 KB

README.md

File metadata and controls

184 lines (122 loc) · 5.26 KB

ECC for Trae

Bring ECC workflows to Trae IDE. This repository provides custom commands, agents, skills, and rules that can be installed into any Trae project with a single command.

Quick Start

Option 1: Local Installation (Current Project Only)

# Install to current project
cd /path/to/your/project
TRAE_ENV=cn .trae/install.sh

This creates .trae-cn/ in your project directory.

Option 2: Global Installation (All Projects)

# Install globally to ~/.trae-cn/
cd /path/to/your/project
TRAE_ENV=cn .trae/install.sh ~

# Or from the .trae folder directly
cd /path/to/your/project/.trae
TRAE_ENV=cn ./install.sh ~

This creates ~/.trae-cn/ which applies to all Trae projects.

Option 3: Quick Install to Current Directory

# If already in project directory with .trae folder
cd .trae
./install.sh

The installer uses non-destructive copy - it will not overwrite your existing files.

Installation Modes

Local Installation

Install to the current project's .trae-cn directory:

cd /path/to/your/project
TRAE_ENV=cn .trae/install.sh

This creates /path/to/your/project/.trae-cn/ with all ECC components.

Global Installation

Install to your home directory's .trae-cn directory (applies to all Trae projects):

# From project directory
TRAE_ENV=cn .trae/install.sh ~

# Or directly from .trae folder
cd .trae
TRAE_ENV=cn ./install.sh ~

This creates ~/.trae-cn/ with all ECC components. All Trae projects will use these global installations.

Note: Global installation is useful when you want to maintain a single copy of ECC across all your projects.

Environment Support

  • Default: Uses .trae directory
  • CN Environment: Uses .trae-cn directory (set via TRAE_ENV=cn)

Force Environment

# From project root, force the CN environment
TRAE_ENV=cn .trae/install.sh

# From inside the .trae folder
cd .trae
TRAE_ENV=cn ./install.sh

Note: TRAE_ENV is a global environment variable that applies to the entire installation session.

Uninstall

The uninstaller uses a manifest file (.ecc-manifest) to track installed files, ensuring safe removal:

# Uninstall from current directory (if already inside .trae or .trae-cn)
cd .trae-cn
./uninstall.sh

# Or uninstall from project root
cd /path/to/your/project
TRAE_ENV=cn .trae/uninstall.sh

# Uninstall globally from home directory
TRAE_ENV=cn .trae/uninstall.sh ~

# Will ask for confirmation before uninstalling

Uninstall Behavior

  • Safe removal: Only removes files tracked in the manifest (installed by ECC)
  • User files preserved: Any files you added manually are kept
  • Non-empty directories: Directories containing user-added files are skipped
  • Manifest-based: Requires .ecc-manifest file (created during install)

Environment Support

Uninstall respects the same TRAE_ENV environment variable as install:

# Uninstall from .trae-cn (CN environment)
TRAE_ENV=cn ./uninstall.sh

# Uninstall from .trae (default environment)
./uninstall.sh

Note: If no manifest file is found (old installation), the uninstaller will ask whether to remove the entire directory.

What's Included

Commands

Commands are on-demand workflows invocable via the / menu in Trae 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. All rules are reused directly from the project root's rules/ folder.

Usage

  1. Type / in chat to open the commands menu
  2. Select a command or skill
  3. The agent will guide you through the workflow with specific instructions and checklists

Project Structure

.trae/ (or .trae-cn/)
├── commands/           # Command files (reused from project root)
├── agents/             # Agent files (reused from project root)
├── skills/             # Skill files (reused from skills/)
├── rules/              # Rule files (reused from project root)
├── install.sh          # Install script
├── uninstall.sh        # Uninstall script
└── README.md           # This file

Customization

All files are yours to modify after installation. The installer never overwrites existing files, so your customizations are safe across re-installs.

Note: The install.sh and uninstall.sh scripts are automatically copied to the target directory during installation, so you can run these commands directly from your project.

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 Trae
  • Type / to see available commands
  • Enjoy the ECC workflows!
0