Macros

Macros

Macros allow you to bind a series of commands to a key and then replay those commands within a session by using that keystroke.

The basic usage is: 1. Press m (macro-record) to begin recording the macro. 2. Go through the commands you wish to record. 3. Then type m again to complete the recording, and prompt for the keystroke or longname to bind it to.

The macro will then be executed every time the provided keystroke is used. Note: the Alt+keys and the function keys are left unbound; overriding other keys may conflict with existing bindings, now or in the future.

Executing a macro will the series of commands starting on the current row and column on the current sheet.

Keystroke Binding

When binding a macro to a longname (like happy-time), you will also be prompted for an optional keystroke shortcut. Type a keystroke (like Alt+s) and press Enter to bind it, or just press Enter to skip.

The keystroke is shown on the Macros Sheet and can be edited there.

Input Parameters

Macro command inputs can use {param} or {param=default} placeholders in the input or col fields. When a parameterized macro is run, VisiData prompts for parameter values before executing.

To add parameters to an existing macro:

1. Open the Macros Sheet with gm.
2. Press Enter on the macro to open its command log.
3. Edit the input or col cells to replace literal values with {param} or {param=default} placeholders.
4. Save the macro with z Ctrl+S.

For example, recording a macro that adds a column with =name + " suffix", then editing the input to {col} + " {text=suffix}", will prompt for col and text values each time the macro runs.

The Macros Sheet

Use gm (macro-sheet) to open an index of existing macros.

To delete a macro, move the cursor to it and press d to mark it for deletion. Then press z Ctrl+S to commit the change. This removes the macro's key binding and deletes its source file.

The helpstr column can be edited to add a description for each macro. This description will show up in the command palette and the Commands Sheet. Save changes with z Ctrl+S.

The keystroke column can be edited to bind or change a keystroke shortcut for a macro.

Enter will open the macro in the current row, and you can view the series of commands composing it.