Commands
CLI commands reference
tmux-ide
Launch the IDE from the current directory. Reads ide.yml and creates a tmux session.
tmux-ideYou can also point it at a different directory:
tmux-ide ~/Developer/other-projectIf a session with the same name already exists, it will reattach to it instead of recreating it. To force a fresh session, run tmux-ide stop first.
tmux-ide init
Scaffold a new ide.yml in the current directory. Auto-detects your project stack and picks the right template.
cd ~/Developer/my-project
tmux-ide init
# → Detected next + convex. Created ide.yml for "my-project".Force a specific template:
tmux-ide init --template nextjsAvailable templates: default, nextjs, convex, vite, python, go
Will refuse to overwrite an existing ide.yml.
tmux-ide stop
Kill the tmux session for the current project.
tmux-ide stopReads the session name from ide.yml. If no config is found, uses the directory name as the session name.
tmux-ide restart
Stop the current session and immediately relaunch it. Equivalent to running tmux-ide stop followed by tmux-ide.
tmux-ide restartUseful when you've changed your ide.yml and want to apply the new layout.
tmux-ide attach
Reattach to a running tmux-ide session.
tmux-ide attachIf the session isn't running, it will suggest starting it with tmux-ide.
tmux-ide ls
List all running tmux sessions.
tmux-ide lsShows session name, creation time, and whether it's currently attached.
tmux-ide doctor
Check that your system meets all requirements.
tmux-ide doctorChecks:
- tmux installed
- tmux version ≥ 3.0
- Node.js ≥ 18
- 256-color terminal
ide.ymlexists in current directory
tmux-ide status
Show the status of the current IDE session.
tmux-ide status
tmux-ide status --jsonReturns session name, running state, config existence, and pane details.
tmux-ide validate
Validate your ide.yml config file.
tmux-ide validate
tmux-ide validate --jsonChecks structure and types: config is an object, rows is a non-empty array, each row has panes, all pane fields have correct types (title/command/dir are strings, focus is boolean, env is an object with string/number values), theme fields are strings, and sizes require a % suffix with values between 1–100%.
tmux-ide detect
Analyze the current project and suggest an ide.yml config.
tmux-ide detect # show what was detected
tmux-ide detect --json # structured output
tmux-ide detect --write # write suggested config to ide.ymlDetects: package manager (npm/pnpm/yarn/bun), frameworks (Next.js, Vite, Convex, Remix, Nuxt, FastAPI, Django, Flask, Go, Rust), and dev commands.
tmux-ide config
Read and modify your ide.yml programmatically.
Dump config
tmux-ide config # print config
tmux-ide config --json # as JSONSet a value
tmux-ide config set name "my-app"
tmux-ide config set rows.0.size "70%"
tmux-ide config set rows.1.panes.0.command "npm run dev"Add a pane
tmux-ide config add-pane --row 1 --title "Tests" --command "pnpm test"Remove a pane
tmux-ide config remove-pane --row 1 --pane 2Add a row
tmux-ide config add-row --size "30%"Enable agent teams
tmux-ide config enable-team --name "my-team"Finds all command: claude panes and assigns the first as lead, the rest as teammate. Adds a team block to the config. See Agent Teams for details.
Disable agent teams
tmux-ide config disable-teamRemoves the team config and all role/task fields from panes.
Global Flags
| Flag | Description |
|---|---|
--json | Output as structured JSON (all commands) |
--template <name> | Use a specific template for init |
--write | Write detected config for detect |