Skip to content

Usage Guide

Jutsu provides an interactive, keyboard-driven interface to compose and run jj (Jujutsu) commands safely and efficiently. By mapping jj’s command taxonomy into an organized, multi-pane layout, you can quickly explore available subcommands and flags with immediate documentation feedback.

Jutsu TUI Interface

Jutsu’s interface is organized into six primary panes and eight focus states, moving from broad category selection through command, subcommand, flag, and input selection, out to a live command preview and executed output. The topics below cover each part of that model in depth:

  1. Interface — panes, focus states, layout, and persistent selection indicators.
  2. Navigation — keyboard controls, horizontal focus movement, pane shortcuts, and quitting.
  3. Commands — categories, command selection, subcommands, and the command-preview mental model.
  4. Flags — optional flags, mandatory flags, conflicts, required groups, and flag indicators.
  5. Inputs — command/flag values, field navigation, required-field validation, and the validation flash.
  6. Global Options — the Global Options modal, options that precede the command, value entry, and pinned indicators.
  7. Running Commands — background execution, standalone terminal handoffs, and multiplexer handoffs.
  8. Output & Docs — pane navigation, scrolling, enlargement, horizontal panning, and clipboard copying.

Building a Jutsu command follows a simple mental model:

What do I want to do? → Commands
How should it behave? → Flags
What values are needed? → Inputs
Which repository/context? → Global Options

Each concept has one canonical page above; the Deep Dive Tutorials below show them combined into concrete, end-to-end scenarios.

To see Jutsu in action and learn specific workflows, explore our dedicated tutorials: