Skip to content

install.md

Latest commit

 

History

History
85 lines (60 loc) · 1.8 KB

install.md

File metadata and controls

85 lines (60 loc) · 1.8 KB
Raw

Installation Guide

Use this page when you are deciding whether to try Local Agent Workbench from GitHub.

Requirements

  • macOS
  • tmux
  • Codex CLI available on your PATH
  • git and python3

Install tmux with Homebrew:

brew install tmux

Install In 60 Seconds

curl -fsSL https://raw.githubusercontent.com/goonobu-dot/local-agent-workbench/main/scripts/install.sh | bash
cd "$HOME/AgentWorkbench/local-agent-workbench"
make first-run

make first-run runs the local doctor, creates a temporary demo workflow, closes it into a handoff summary, and lists available workflow templates.

If you want to inspect the flow before running commands, read docs/demo-transcript.md.

Try Without Installing

Clone first if you want to inspect the scripts before running the installer:

git clone https://github.com/goonobu-dot/local-agent-workbench.git
cd local-agent-workbench
./scripts/doctor.sh
make demo

First Real Workflow

./scripts/create_workflow_from_url.sh https://github.com/owner/repo/issues/123
AGENT_WORKBENCH_IDEA_DIR="$HOME/AgentWorkbench/Idea" \
AGENT_WORKBENCH_USE_ROLE_PROMPTS=1 \
./scripts/launch_codex_tmux.sh

If Setup Fails

make doctor-report

Review doctor-report.md before sharing it publicly. It is designed to make bug reports easier, but you should remove anything private before posting.

Uninstall

Dry-run first:

./scripts/uninstall.sh

Remove the installed checkout:

AGENT_WORKBENCH_CONFIRM_UNINSTALL=1 ./scripts/uninstall.sh

Also remove the generated app and idea folder:

AGENT_WORKBENCH_CONFIRM_UNINSTALL=1 \
AGENT_WORKBENCH_REMOVE_APP=1 \
AGENT_WORKBENCH_REMOVE_IDEA=1 \
./scripts/uninstall.sh

The uninstaller does not remove anything unless confirmation is explicit.