Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

CLI Reference

Usage

vibe-action <action> [query] [args...]

vibe-action docs "How to use the 'contains' operator?"
vibe-action info
vibe-action --help

Each <action> maps to a YAML-defined action. Use --help to list all available actions and their arguments:

vibe-action --help
vibe-action docs --help

Action groups

Actions from external repositories or local directories are nested under a group command:

vibe-action <group> <action> [query] [args...]

vibe-action code review main.rs
vibe-action project commit .

Groups are declared in config.yaml and loaded on startup — see Configuration.

  • vibe-action <group> prints the group’s action list.
  • vibe-action <group> <action> --help prints action-specific help.

System commands

vibe-action status   # Show version, paths, action counts
vibe-action clean    # Remove stale cache, temp files, clipboard
vibe-action stop     # Stop all running vibe-action processes

Action arguments

Actions define their own CLI arguments in YAML. See YAML Format for the args schema.

vibe-action project commit -d         # dry-run flag (bool)
vibe-action data extract -f log.txt   # file argument (string)

Singleton guard

By default, only one vibe-action process runs at a time. Starting a new action automatically stops the previous one (graceful shutdown with a 3-second timeout, then force-kill). This keeps shared state (cache, local LLMs) predictable.

Disable with VIBE_SKIP_LOCK:

VIBE_SKIP_LOCK=1 vibe-action code review main.rs

Useful for parallel API clusters or when running multiple actions concurrently.

Interactive confirm

Actions with ask: true prompt for user approval before execution:

  • CLI — inquire confirm dialog with the command preview.
  • JSON mode — confirm protocol via stdin/stdout (30-second timeout, fail-closed).

Interactive prompt

Actions using query_prompt trigger an interactive input when no query is provided on the command line:

  • CLI — inquire text prompt labeled “Query”.
  • IDE — plugin opens an input dialog.

Desktop notifications

Actions with notify: true send a desktop notification on completion (CLI mode only):

  • macOS — via terminal-notifier (install: brew install terminal-notifier).
  • Linux — via notify-rust (freedesktop.org D-Bus spec).

Role mismatch warning

If a pipeline uses a run size (e.g. large) but no cluster node has the matching role, the engine warns and offers to continue with all available nodes (fallback). In CLI mode this is a confirm dialog; in JSON mode it uses the confirm protocol.

See Configuration for cluster role setup.

Environment variables

VariableDescriptionDefault
VIBE_CONFIGPath to config file~/.vibe-action/config.yaml
VIBE_ACTION_PATHPath to actions directory~/.vibe-action/actions/
VIBE_SKIP_LOCKDisable singleton guard for parallel executionNot set (guard enabled)
VIBE_TESTInternal test mode (1 = enabled)Not set

Output-related variables (VIBE_LOG_TYPE, VIBE_TRACE_LEVEL) and trace levels — see Output Modes.

Exit codes

CodeDescription
0Success
1Error (validation, shell command, LLM failure)
130Instance superseded by a newer run (auto-cancelled)