Skip to content
Zide Zide Zide

Multi-step command

You can use multi-step commands to separate large tasks into multiple reviewable steps. Use a multi-step command when a task is too large to verify in one response. You can save a multi-step prompt as a command, or enter one directly into the Zide Assist message box.

Create a multi-step command

Steps in a multi-step command are separated with --- on a blank line.

To create a multi-step command, complete the following steps.

  1. In the Commands activity, click New Command.
  2. Under Save in, click All Projects or This Project.
  3. Enter the name of the command in the Display Name field. Zide makes the Command Name from it, in lowercase with hyphens. For example, Fix Issue becomes /fix-issue. Use the command name to run the command in Zide Assist.
  4. Optional: Enter the description of the command in the Description field.
  5. Optional: To add an input to the command, click Add Input. Input types are text, textarea, bool, and enum. Reference each input with a {{name}} placeholder in the steps that use it. Zide does not add unreferenced input values to a multi-step command.
  6. Enter what the command should do in the Prompt field. Separate steps with --- on a blank line.
  7. Click Enable multi-step processing to make it a multi-step command.
  8. Optional: Click Auto-submit steps to enable Zide to go through each step automatically. You can set the amount of time between steps in the Delay between steps field.
  9. Click Save. Zide automatically detects the number of steps.

Run a multi-step command

To run a saved multi-step command, type a forward slash, /, followed by the command name into the Zide Assist message box and then click Send. You can also enter a multi-step command directly into the Zide Assist message box.

Ask Zide runs one prompt, so you cannot run a multi-step command in Ask Zide.

The Zide Assist tab lists your current step and the total number of steps. When steps run manually, click Next to advance to the next step. Click Cancel to stop the run at any point.

When a multi-step command is set to Auto-submit steps, each step runs automatically.

The remaining steps appear as an editable list. Edit a step in the list to change it before it sends, or click the Remove this step icon to skip the step.

Queued messages are sent to Zide Assist at the end of the multi-step command.

Edit a multi-step command file manually

Like any command, a multi-step command can be authored by hand as a Markdown file with YAML frontmatter. A multi-step command adds these frontmatter fields:

  • mode: prompt-script marks the command as multi-step.
  • auto-submit: false runs the steps manually. Auto-submit is on by default when mode is prompt-script.
  • delay sets the pause between auto-submitted steps, written as a number of seconds (for example, delay: 2s).

For more information about commands, see Commands.