Skip to content

workflows.md

Latest commit

 

History

History
235 lines (151 loc) · 4.81 KB

workflows.md

File metadata and controls

235 lines (151 loc) · 4.81 KB

workflows command group

Manage multi-step automation workflows.

Table of Contents

workflows set

Create or update a workflow with interactive step entry.

Syntax

byo workflows set --name <name> --bookmark <path>

Options

Option Required Description
--name Yes Workflow name
--bookmark Yes Bookmark hierarchy path

Behavior

Supports these step types:

  1. Message
  2. YesNoQuestion
  3. InputAsSetting
  4. InputAsSecret
  5. ExecuteCommand

Steps execute in the order created.

Workflow step types (detailed)

When you run byo workflows set, BYO repeatedly asks you to choose a step type and configure it.

1) Message

Use this step to display status updates, guidance, or checkpoints.

Interactive prompts:

  • Enter message to display
  • Select message color
  • Wait for user to press Enter after displaying message?

Fields captured:

  • Prompt (the text to show)
  • Color (for terminal output)
  • WaitForEnter (Yes/No)

Good use cases:

  • Start/end banners (for example, "Starting deployment")
  • Human-readable progress markers
  • Manual pause points before sensitive actions

2) YesNoQuestion

Use this step for confirmation gates.

Interactive prompts:

  • Enter question to ask
  • Interrupt workflow if answer is No?

Fields captured:

  • Prompt (question text)
  • InterruptOnNo (Yes/No)

Behavior notes:

  • If InterruptOnNo is enabled and the answer is No, the workflow stops.
  • If disabled, the workflow continues regardless of answer.

Good use cases:

  • "Proceed with production deployment?"
  • "Did backup complete successfully?"

3) InputAsSetting

Use this step to collect runtime input and store it as a setting.

Interactive prompts:

  • Enter prompt message
  • Enter setting key name

Fields captured:

  • Prompt (what to ask)
  • StorageKey (setting key to save value into)

Behavior notes:

  • Value is stored as a regular (non-secret) setting.
  • The saved key can be referenced later with token syntax (for example {{MyKey}}).

Good use cases:

  • Branch name
  • Environment name (dev, staging, prod)
  • Non-sensitive URLs or IDs

4) InputAsSecret

Use this step to collect sensitive input and store it as a secret.

Interactive prompts:

  • Enter prompt message
  • Enter secret key name

Fields captured:

  • Prompt (what to ask)
  • StorageKey (secret key to save value into)

Behavior notes:

  • Value is stored via the secrets system (encrypted at rest).
  • The saved key can be referenced later with token syntax.

Good use cases:

  • Temporary API tokens
  • One-time passwords
  • Per-run credentials

5) ExecuteCommand

Use this step to run an existing saved command from the command library.

Interactive prompts:

  • Select command
  • Run this command asynchronously in background?

Fields captured:

  • CommandName (selected saved command)
  • RunAsync (Yes/No)

Behavior notes:

  • Requires at least one saved command to exist.
  • If no commands exist, BYO shows an error and asks for another step choice.
  • Command execution supports token replacement the same way as byo run --target command.

Good use cases:

  • Build, test, package, deploy sequences
  • API smoke checks
  • Cleanup and verification commands

Example step sequence

Typical production workflow structure:

  1. Message — announce start
  2. YesNoQuestion — confirm continuation
  3. InputAsSetting — collect environment/branch
  4. InputAsSecret — collect temporary token
  5. ExecuteCommand — run build
  6. ExecuteCommand — run deploy
  7. Message — announce completion

Step design tips

  • Keep each step focused on one action.
  • Add Message steps before and after risky operations.
  • Use YesNoQuestion before irreversible changes.
  • Prefer InputAsSecret for anything credential-like.
  • Reuse saved commands in ExecuteCommand steps to keep workflows maintainable.

workflows list

List workflows.

Syntax

byo workflows list

workflows delete

Delete a workflow.

Syntax

byo workflows delete

Behavior

  • Uses interactive selection
  • Confirms before delete