CLI Overview

Crush comes with useful CLI that have good flags that will help you while you use it.

Usage

crush [command] [--flags]

Examples

# Run in interactive mode
crush

# Run with debug logging
crush -d

# Run with debug logging in a specific directory
crush -d -c /path/to/project

# Print version
crush -v

# Run a single non-interactive prompt
crush run "Explain the use of context in Go"

# Run in dangerous mode (auto-accept all permissions)
crush -y

Commands

Global Flags

Sub commands

# completion sub-command

You can add crush cli commands auto completion for your shell and we support those right now:

crush completion bash 

crush completion fish 

crush completion powershell 

crush completion zsh 

Usage

crush completion [command] --flags

Flags:

# run sub-command

If you don't want to run the whole TUI and just need a quick single prompt, the run command is for you.

Run a simple prompt:

ask a question directly

crush run Explain the use of context in Go

Pipe input from stdin:

If you want to run it using echo

echo "What is this code doing?" | crush run

Run with quiet mode (no spinner)

This will disable the response spinner

crush run -q "Generate a README for this project"

Usage

crush run [prompt ...] [--flags]

Flags

# logs sub-command

You can view the logs generated by Crush.
This command allows you to monitor and debug by inspecting the log output.

Usage

crush logs [--flags]

Flags

TUI Overview

The Crush TUI provides a set of keyboard shortcuts and commands that make it faster and easier to interact with the assistant directly from your terminal.
Below you can find the main keybindings and the available commands you can trigger inside the TUI.

Keybindings

Keybindings are the main shortcuts you can use inside the TUI to quickly perform actions without leaving the keyboard.

General

These are basic shortcuts that help you interact with the chat smoothly.

Navigation

Use these shortcuts to move around the interface or trigger quick navigation features.

Sessions

Manage and organize your sessions (chat contexts) using these shortcuts.

Commands

The commands palette (opened with Ctrl+P) allows you to access higher-level actions inside the TUI.
Think of it like a quick menu where you can start sessions, switch models, or toggle features without remembering all the shortcuts.