YAML Workflows
Workflows are an easier way to execute and share commands within Warp.
You can continue to use YAML-based workflows, but we recommend using new workflows in Warp Drive instead for a better editing experience.
What is it
Workflows are easily parameterized and searchable by name, description, or command arguments. Common workflows 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.
How to use it
Press Command Search or through the Command Palette 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, 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.
Tailor your Command Search experience by toggling off "Show Global Workflows" in Settings > Features
. When disabled, your search will exclusively encompass YAML and Warp Drive Workflows.
How it works
How is this Different from Aliases?
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
Creating Custom Workflows
How to create a workflow with YAML
You can store local workflows (scoped to your machine) in:
~/.warp/workflows/
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.
See the existing workflow spec within the Workflows repo for examples. Additionally, we outline the file format below:
Where to save workflows
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.
Local Workflow Path:
~/.warp/workflows/
Repository Workflow Path: {{path_to_git_repo}}/.warp/workflows
Local Workflows
To start, create a workflow subdirectory within
mkdir -p ~/.warp/workflows/
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}}
Repository Workflows
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:
Global Workflows
You can contribute workflows that will be made available to other Warp users by forking the Workflows repo and opening a pull request. See the Contributing section for more details.
Last updated