bivvy add
Adds a template step to your existing .bivvy/config.yml configuration file.
Usage
bivvy add <template>bivvy add bundle-install --as ruby_depsbivvy add yarn-install --after bundle-installbivvy add pre-commit --no-workflowArguments
| Argument | Description |
|---|---|
<template> | Name of the template to add (required) |
Options
| Option | Description |
|---|---|
--as <NAME> | Step name to use in config (defaults to template name) |
--workflow <NAME> | Workflow to add the step to (defaults to default) |
--after <STEP> | Insert after this step in the workflow |
--no-workflow | Don’t add the step to any workflow |
What It Does
- Validates the template exists in the registry
- Validates a config file exists (run
bivvy initfirst if not) - Checks the step name doesn’t already exist
- Appends the new step to the end of the
steps:section - Adds the step to the specified workflow’s step list
- Preserves all existing comments and formatting
The generated step block matches the format from bivvy init — a template reference with commented-out details:
steps: # ... existing steps ...
bundle-install: template: bundle-install # command: bundle install # completed_check: # type: command_succeeds # command: "bundle check" # watches: [Gemfile, Gemfile.lock]Examples
Add a template with the default step name
bivvy add bundle-installThis creates a step named bundle-install using the bundle-install template and adds it to the end of the default workflow.
Add with a custom step name
bivvy add bundle-install --as ruby_depsCreates a step named ruby_deps that uses the bundle-install template. Useful when you want a more descriptive name, or when you already have a step with the template’s default name.
Insert at a specific position
bivvy add yarn-install --after bundle-installAdds the yarn-install step to the default workflow immediately after bundle-install, rather than at the end.
Add to a specific workflow
bivvy add rails-db --workflow ciAdds the rails-db step to the ci workflow instead of default.
Add without a workflow
bivvy add pre-commit --no-workflowAdds the step to the config but doesn’t add it to any workflow. Useful for steps you’ll reference in custom workflows later.
Discover templates first
# See what's availablebivvy templates
# Filter to a categorybivvy templates --category ruby
# Add onebivvy add rails-dbError Cases
| Error | Cause |
|---|---|
| ”No configuration found” | No .bivvy/config.yml exists — run bivvy init first |
| ”Unknown template” | The template name doesn’t match any built-in, local, or remote template |
| ”Step already exists” | A step with that name already exists — use --as to pick a different name |
See Also
bivvy templates— Browse available templatesbivvy init— Initialize configuration from scratchbivvy list— List configured steps and workflows- Templates Overview — How the template system works