Skip to content

CLI reference ​

claudegrid ​

txt
claudegrid [preset] [options] [-- claude flags]
OptionDescription
-l, --layout <grid>COLSxROWS like 3x2, or a pane count. Default 2x2
-n, --panes <count>same as --layout <count>
-p, --prompt <text>prompt for the next pane. Repeat it for more panes
-m, --model <model>model for every pane
-w, --worktreesone git worktree and branch per pane
--no-worktreesturn worktrees off when the config turns them on
-b, --backend <name>auto, konsole, iterm2, tmux, kitty, wezterm or terminal
-C, --cwd <dir>run from this directory
-c, --config <file>use this config instead of .claudegrid.json
-t, --name <name>name for the window, tmux session and worktree group
--command <cmd>run another program instead of claude
--no-keep-shellclose the pane when the program exits
--no-new-tabopen a new window instead of a tab in the terminal you are in
--no-trustlet Claude Code ask its folder trust question in every pane. By default claudegrid marks the pane folders as trusted
-d, --detachstart the tmux session without attaching
--dry-runprint the plan and the commands, open nothing
--jsonprint the plan as JSON
-h, --helphelp
-v, --versionversion

Everything after -- is passed to every claude.

claudegrid ui ​

Opens the desktop app in its own window.

OptionDescription
-C, --cwd <dir>project to open first
--port <port>fixed port instead of a random one
--no-openprint the link without opening a window
--keep-alivekeep the server running after the window closes

claudegrid desktop ​

claudegrid desktop install adds claudegrid to your app menu. claudegrid desktop uninstall removes it.

claudegrid init ​

Creates .claudegrid.json at the root of the git repo, or in the current directory outside a repo. It has four example panes and two presets. --force overwrites an existing file.

claudegrid doctor ​

Checks Node.js, Claude Code, git, every terminal backend and your config files. It exits with 1 when claudegrid cannot launch.

claudegrid update ​

Installs the latest claudegrid from npm into the same place the current one lives. --check only prints whether a newer version exists. Copies installed with apt or the AUR are updated by those instead.

claudegrid presets ​

Lists presets from the project and user config. --names prints only the names, which the shell completions use.

claudegrid worktrees ​

CommandDescription
claudegrid worktreeslist claudegrid worktrees with changed files and commits ahead
claudegrid worktrees cleanremove clean worktrees and merged branches
... clean --forcealso remove worktrees with changes and unmerged branches
... clean --keep-branchesremove worktrees but keep every branch
... clean --dry-runonly show what would be removed

claudegrid completion ​

sh
claudegrid completion bash|zsh|fish

Prints a completion script. See Getting started.

Exit codes ​

CodeMeaning
0success
1an error, with a message and usually a hint

Released under the MIT License.