magus v0.4.3 is out. See what's new
¶ View markdown source · ✎ Suggest an edit

Command bar

The console's runner: one searchable list of every command and its chord, opened with mod+k. It is the discoverable route to any action: the menus and chords dispatch the same commands it does.

Example

mod+k

Used in

In the code (magus refs <name> lists every site):

  • CommandBar (TypeScript, magus-console)

See also

glossaryconsole
Last updated (2df714e8)
Glossary

Op

A single tool-native command a target composes (long form: operation); the middle of the work hierarchy (Spell to Op to Target). Op in full.

Knowledge graph

The queryable graph of a workspace's spells, targets, docs, and code relationships; query it with magus query/explain/path. Knowledge graph in full.

Run

One target executing under one magus invocation, such as magus run test web or magus affected ci. A run keeps its captured output behind an output reference. Every magus run is a run whether or not any job asked for it; see Job for how the two relate. Run in full.

Chord

A key combination bound to a console command, written mod+k, where mod is Cmd on macOS and Ctrl elsewhere, so one binding fits both. Every chord is rebindable (Settings > Keybindings), and a command remains reachable from the command bar whether or not it has one. Chord in full.

Command bar

The console's runner: one searchable list of every command and its chord, opened with mod+k. It is the discoverable route to any action: the menus and chords dispatch the same commands it does. Command bar in full.

Conventions

Placeholders

Angle brackets mark a value you replace with your own; never type the brackets:

magus run <target>
magus completion <shell>    # e.g. bash, zsh, fish

<target>, <path>, <shell>, <name> and the like are stand-ins, not literal text.