Update README Docker section with new containers
- Document Dockerfile.ready (pre-installed container) - Document Dockerfile.test-install (fresh install testing) - Document install.sh interactive installer - Keep legacy docker-compose as fallback option Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
63149aec07
commit
b1d1a3692d
65
README.md
65
README.md
|
|
@ -497,33 +497,66 @@ MIT - Use it, modify it, share it.
|
||||||
|
|
||||||
## Docker
|
## Docker
|
||||||
|
|
||||||
### Pre-built Container (Fastest)
|
### Pre-installed Container (Recommended)
|
||||||
|
|
||||||
Pull and run the pre-built image directly:
|
Ready-to-use container with CmdForge and 27 example tools pre-installed:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Pull from registry
|
# Build from source
|
||||||
docker pull gitea.brrd.tech/rob/cmdforge:latest
|
docker build -f Dockerfile.ready -t cmdforge-ready .
|
||||||
|
|
||||||
# Run CmdForge
|
# Run interactively
|
||||||
docker run -it --rm gitea.brrd.tech/rob/cmdforge cmdforge --help
|
docker run -it --rm cmdforge-ready
|
||||||
|
|
||||||
# List available tools
|
# With persistent storage (keeps your tools between runs)
|
||||||
docker run -it --rm gitea.brrd.tech/rob/cmdforge cmdforge list
|
docker run -it --rm -v cmdforge-data:/home/user/.cmdforge cmdforge-ready
|
||||||
|
|
||||||
# Interactive shell
|
|
||||||
docker run -it --rm gitea.brrd.tech/rob/cmdforge bash
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Build from Source
|
Inside the container, CmdForge is ready to use:
|
||||||
|
```bash
|
||||||
|
cmdforge list # See 27 pre-installed tools
|
||||||
|
cmdforge ui # Launch the TUI
|
||||||
|
cmdforge run summarize # Run a tool
|
||||||
|
```
|
||||||
|
|
||||||
Alternatively, build the container yourself:
|
### Test Installation Container
|
||||||
|
|
||||||
|
Simulates a fresh computer for testing the installation process:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clone the repo
|
# Build the test container
|
||||||
git clone https://gitea.brrd.tech/rob/CmdForge.git
|
docker build -f Dockerfile.test-install -t cmdforge-test-install .
|
||||||
cd CmdForge
|
|
||||||
|
|
||||||
|
# Run interactively
|
||||||
|
docker run -it --rm cmdforge-test-install
|
||||||
|
|
||||||
|
# Inside the container - run the installer
|
||||||
|
cd ~/CmdForge
|
||||||
|
./install.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
### Interactive Installer
|
||||||
|
|
||||||
|
The `install.sh` script provides guided installation:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./install.sh # Full interactive install
|
||||||
|
./install.sh --yes # Non-interactive (accept defaults)
|
||||||
|
./install.sh --no-venv # Install without virtual environment
|
||||||
|
./install.sh --no-examples # Skip installing example tools
|
||||||
|
```
|
||||||
|
|
||||||
|
Features:
|
||||||
|
- Creates virtual environment at `~/.cmdforge-venv`
|
||||||
|
- Configures PATH in your shell config (bash/zsh/fish)
|
||||||
|
- Optionally installs 27 example tools
|
||||||
|
- Works on macOS and Linux
|
||||||
|
|
||||||
|
### Legacy Container
|
||||||
|
|
||||||
|
The original docker-compose setup still works:
|
||||||
|
|
||||||
|
```bash
|
||||||
# Build the container
|
# Build the container
|
||||||
docker-compose build
|
docker-compose build
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue