diff --git a/.README.md b/.README.md index 1f2d44d..7b166df 100644 --- a/.README.md +++ b/.README.md @@ -1,329 +1,53 @@ # Git Agent Sync -A CLI tool that manages isolated git worktrees for AI coding agents, enabling parallel development without conflicts. - -## Overview - -Git Agent Sync solves the problem of managing multiple AI coding agents working on the same codebase. Each agent gets its own isolated git worktree, allowing parallel development without branch conflicts. - -### Key Features - -- **Per-Agent Worktree Isolation** - Each agent works in a separate git worktree -- **Automatic Environment Configuration** - Environment variables and dependencies are auto-configured -- **Change Tracking** - Track agent-specific file changes with metadata -- **Unified Diff Generation** - Generate diffs for code review with agent attribution -- **Safe Merge Workflows** - Merge changes back to main with validation checks +A CLI tool that manages isolated git worktrees for AI coding agents. ## Installation -### From Source - -```bash -# Clone and install -git clone https://7000pct.gitea.bloupla.net/7000pctAUTO/git-agent-sync.git -cd git-agent-sync -npm install -npm run build - -# Link globally -npm link -``` - -### Global Installation - ```bash npm install -g git-agent-sync ``` -## Quick Start +## Usage -1. **Initialize in a git repository:** +### Create a new agent workspace ```bash -cd your-git-repo -git-agent-sync init +git-agent-sync create ``` -2. **Create a workspace for an agent:** +This creates an isolated git worktree for the specified AI agent. + +### List all workspaces ```bash -git-agent-sync create claude-code +git-agent-sync list ``` -3. **Work in the workspace:** +### Check workspace status ```bash -cd .agent-workspaces/agent-claude-code -# Make your changes -git status +git-agent-sync status ``` -4. **Generate a diff for review:** +### Generate diff for review ```bash -git-agent-sync diff claude-code +git-agent-sync diff ``` -5. **Merge changes back to main:** +### Merge changes back to main ```bash -git-agent-sync merge claude-code +git-agent-sync merge ``` -6. **Clean up when done:** +### Destroy a workspace ```bash -git-agent-sync destroy claude-code +git-agent-sync destroy ``` -## Commands - -### create - -Create an isolated worktree for an AI agent. - -```bash -git-agent-sync create [options] -``` - -**Options:** -- `-p, --path ` - Custom path for the workspace -- `-t, --template