YAML Workflows
Workflows are an easier way to execute and share commands within Warp.
Last updated
Was this helpful?
Workflows are an easier way to execute and share commands within Warp.
Last updated
Was this helpful?
You can continue to use YAML-based workflows, but we recommend using new instead for a better editing experience.
Workflows are easily parameterized and searchable by name, description, or command arguments. sourced by the Warp team and community are readily available within the app. Additionally, you can create and scope Workflows locally or to a git repository.
Open the or Workflow Search CTRL-SHIFT-R
panel to find Workflows.
Once inside the menu, start typing in the search bar to filter the existing Workflows. (e.g. git, android, npm, etc.)
When a Workflow is selected with ENTER
, you can use SHIFT-TAB
to cycle through the arguments.
You can also expand the menu horizontally with the mouse by dragging it on the right edge.
Workflows solve some major pain points with aliases, specifically the:
need to context switch
leave vim, source dotfiles, or reset shell
difficulty with attaching documentation
inability to easily search or share
inability to easily parameterize
You can store local workflows (scoped to your machine) in:
Or, you can share them with your team by saving them in {{path_to_git_repo}}/.warp/workflows/
. Local and repository Workflows can be accessed under the "My Workflows" and "Repository Workflows" tab of the Workflows menu, respectively.
Local Workflows are scoped to your machine. Repository Workflows are scoped to a git repository and can be accessed by anyone who has cloned the repo. Note: Repository Workflows will not appear if you are ssh into a remote machine.
To start, create a Workflow subdirectory within
Add your Workflowโs .yaml
file to this directory; if the file format is valid Warp should automatically load it into the Workflows menu.
cp ~/path/to/my_awesome_workflow.yaml {{path_to_local_workflow_folder}}
You can add a repository Workflow similarly to how you added a local Workflow. Create a Workflows folder in a repositoryโs root directory and save your .yaml
file like so:
See the existing Workflow spec within the for examples. Additionally, we outline the file format below:
You can contribute Workflows that will be made available to other Warp users by forking the and opening a pull request. See the section for more details.
The Workflow file format is a file and must have either a `.yml ` or `yaml` extension. If you're new to YAML and want to learn more, see .
The URL from where the Workflow was originally generated from. This is surfaced in for attribution purposes. Optional.
The original author of the Workflow. For example, if this Workflow was generated from StackOverflow, the author
would be the author
of the StackOverflow post. This is surfaced in for attribution purposes. Optional.
The URL of original author of the Workflow. For example, if this Workflow was generated from StackOverflow, the author_url
would be the StackOverflow author's profile page. This is surfaced in for attribution purposes. Optional.
The description of the argument. This is surfaced in both and Warp to help users fill in Workflow arguments. Optional