Simplify and clarify project documentation

Streamline documentation to focus on core functionality and conda
integration. Changes include:
- Clarify default design and conda environment usage
- Remove redundant workflow benefits section
- Simplify features list to focus on key capabilities
- Remove directory structure (available in repo)
- Add explicit push requirement in CLAUDE.md
- Update task completion requirements

This makes the documentation more focused and easier to understand while
emphasizing the project's integration with conda environments.
This commit is contained in:
Vishal Jain 2025-06-18 14:58:59 +01:00
parent b97a5c17ba
commit ddf35828e2
2 changed files with 7 additions and 27 deletions

View File

@ -6,15 +6,14 @@ A Docker container setup for running Claude Code with full autonomous permission
This codebase includes a custom `CLAUDE.md` template that configures Claude as an autonomous task executor. Located at `/templates/.claude/CLAUDE.md`, this file provides detailed instructions for how Claude should behave when executing tasks.
**Default Usage:** The claude-docker agent expects a detailed `plan.md` file in your project root containing task specifications. Claude will read this plan and execute it as faithfully as possible, documenting progress in `task_log.md`.
**Default Design:** The claude-docker agent expects a detailed `plan.md` file in your project root containing task specifications and which conda env to use. Claude will read this plan and execute it as faithfully as possible, documenting progress in `task_log.md`, send a text on completion if you set up your twilio credentials (optional). Simply tell it to make sure it has read the user scope claude md file and to execute.
## What This Does
- Runs Claude Code in an isolated Docker container with full autonomy
- Integrates Twilio MCP for SMS notifications when tasks complete
- Provides persistent context across sessions
- Auto-configures Claude settings for seamless operation
- Simple one-command setup and usage
- Runs Claude Code in an isolated Docker container with full autonomy.
- Integrates Twilio MCP for SMS notifications when tasks complete.
- Simple one-command setup and usage.
- Integrates existing conda environments to avoid custom env instructions in the Dockerfile.
- Documents work in a file `task_log.md`.
## Prerequisites
@ -124,11 +123,6 @@ For the best experience, run `claude-docker` once per project and leave it runni
docker stop claude-docker-session
```
This workflow gives you:
- ✅ Persistent authentication (login once per machine)
- ✅ Persistent project context (one session per project)
- ✅ Perfect file permissions between host and container
- ✅ No repeated setup or authentication
## Features
@ -176,20 +170,6 @@ This workflow gives you:
4. **Project Mounting**: Your project directory mounts to `/workspace`
5. **Clean Exit**: Container removes itself when Claude session ends
## Directory Structure
```
claude-docker/
├── Dockerfile # Main container definition
├── .env.example # Template for environment variables
├── scripts/
│ ├── claude-docker.sh # Wrapper script for container
│ ├── install.sh # Installation script
│ └── startup.sh # Container startup script
└── templates/
└── .claude/
└── CLAUDE.md # Claude behavior instructions
```
## How This Differs from Anthropic's DevContainer

View File

@ -90,7 +90,7 @@ Upon successful task completion:
1. Clean up temporary files and stop unnecessary processes
2. Leave environment in clean, reproducible state
3. Complete final documentation in `task_log.md`
4. Make git commits following the commit message rules below
4. Make git commits following the commit message rules below. ALWAYS PUSH TO REMOTE.
5. If Twilio is configured (all env vars present), send completion message to `$TWILIO_TO_NUMBER` with summary
6. Completion msg MUST include a remote url link. See below for generation instructions.