CLI Reference

All commands, flags, and environment variables for the grutcommand-line interface.

Root Command

grut [flags] [command]

AI-native terminal file explorer, git client, and agent orchestrator. Running grut with no arguments launches the interactive TUI in the current directory.

Global Flags

Key	Action
`--no-ai`	Disable AI features for this operation
`--demo`	Launch with a demo project to explore grüt
`--layout <name>`	Start with a layout: explorer, git, review, agent, or full
`--reset-welcome`	Reset first-run state so the welcome screen shows on next launch
`-h, --help`	Show help information
`-v, --version`	Show version information

Environment Variables

Key	Action
`GRUT_LOG`	Path to a log file (enables debug logging)
`GRUT_NERD_FONT`	Set to 1 to force Nerd Font icons in any terminal
`GRUT_FORCE_TERMINAL`	Set to any non-empty value to bypass the MinTTY/MSYS check on Windows

# Enable debug logging
export GRUT_LOG=/tmp/grut-debug.log
grut

Commands

version

Print the current grüt version.

grut version

update

Update grüt to the latest release. Downloads are SHA-256 verified to ensure integrity.

grut update

status

Print a summary of the working tree status. Add --json for scriptable output.

grut status
grut status --json

config

Inspect grüt configuration.

# Validate the active config
grut config check

# Print one resolved value by dotted key
grut config get git.default_branch

# Print the full default config as TOML
grut config defaults

Key	Action
`check`	Validate the active configuration
`get <key>`	Print a single resolved config value
`defaults`	Print the default configuration as TOML

theme

Inspect grüt themes.

# List available themes
grut theme list

keys

Print keybindings from the command line.

grut keys
grut keys --filter commit
grut keys --json

Key	Action
`--filter <text>`	Only show sections, keys, or actions matching the text
`--json`	Print keybindings as JSON

clean

Remove grüt's transient session and diagnostic data. Without--force it only previews what would be removed.

# Preview what would be removed
grut clean

# Delete the transient data
grut clean --force

completion

Generate shell completion scripts for bash, zsh, fish, or PowerShell.

grut completion bash
grut completion zsh
grut completion fish
grut completion powershell

report

View crash reports and file GitHub issues for them.

# List all crash reports
grut report --list

# Show a specific report by ID
grut report --show <id>

# Open a GitHub issue for the most recent crash
grut report --latest

# Clear all crash reports
grut report --clear

Key	Action
`--list`	List all crash reports
`--show <id>`	Show a specific crash report by ID
`--latest`	Open a GitHub issue for the most recent crash
`--clear`	Clear all crash reports
`--no-browser`	Print the issue URL instead of opening the browser
`--json`	Print list output as JSON

mcp

Run grüt as an MCP (Model Context Protocol) server, communicating via stdin/stdout JSON-RPC. Use grut mcp tools to list the tools the server exposes.

# Standard MCP mode (stdin/stdout)
grut mcp

# List the MCP tools grüt exposes
grut mcp tools

Key	Action
`tools`	List the MCP tools grüt exposes
`--socket <path>`	Serve over a Unix socket (not yet implemented)

run

Execute an AI-powered git workflow shortcut. Shortcuts are predefined sequences of git operations that can be invoked by name.

# Run a shortcut
grut run pr-review

# List available shortcuts
grut run --list

# Describe what a shortcut does
grut run --describe pr-review

# Preview without executing
grut run --dry-run pr-review

# Skip confirmation prompts
grut run --no-confirm pr-review

Key	Action
`--list`	List all available shortcuts
`--describe <name>`	Show what a shortcut does without running it
`--dry-run`	Preview the operations without executing them
`--no-confirm`	Skip confirmation prompts

ext

Manage grüt extensions. Extensions add new panels, commands, and integrations to the TUI.

# Create a new extension scaffold
grut ext create my-extension

# Install an extension
grut ext install my-extension

# Remove an extension
grut ext remove my-extension

# List installed extensions
grut ext list

# Enable / disable an extension
grut ext enable my-extension
grut ext disable my-extension

# Show extension details
grut ext info my-extension

Key	Action
`create`	Scaffold a new extension project
`install`	Install an extension
`remove`	Remove an installed extension
`list`	List all installed extensions
`enable`	Enable a disabled extension
`disable`	Disable an extension without removing it
`info`	Show details about an extension

Examples

# Launch grüt in the current directory
grut

# Launch with AI features disabled
grut --no-ai

# Try grüt with a demo project
grut --demo

# Update to the latest version
grut update

# Use as an MCP server in your AI toolchain
grut mcp