diff --git a/templates/default/README.md b/templates/default/README.md index ca09c27..f6dfbaa 100644 --- a/templates/default/README.md +++ b/templates/default/README.md @@ -1,17 +1,22 @@ -# Agent Workspace Template +# Agent Workspace Setup -This template provides a starting point for agent workspaces. +This directory contains an isolated workspace for an AI agent. -## Environment Variables +## Quick Start -The following environment variables are automatically set: -- `AGENT_ID`: The identifier for this agent -- `WORKSPACE_PATH`: The path to this workspace -- `AGENT_WORKSPACE`: Same as WORKSPACE_PATH -- `GIT_USER_EMAIL`: Git user email from global config -- `GIT_USER_NAME`: Git user name from global config -- `AGENT_CREATED_AT`: Timestamp when workspace was created +1. The environment has been automatically configured +2. Check your `.env` file for available variables +3. Dependencies have been installed if a `package.json` was present -## Customization +## Commands -To add custom environment variables, create a `.env.custom` file in this template directory. +- `git-agent-sync status` - View current changes +- `git-agent-sync diff` - Generate a diff for review +- `git-agent-sync merge` - Merge changes back to main +- `git-agent-sync destroy` - Remove this workspace (use with caution!) + +## Tips + +- Make your changes and use `git status` to track them +- Use `git-agent-sync diff` to generate a code review diff +- When ready, run `git-agent-sync merge` to merge back to the main branch