Workflows are an easier way to execute and share commands within Warp. They 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.
CTRL-SHIFT-Rto open the Workflow menu or through the Command Palette
- Once inside the menu, start typing in the search bar to filter the existing workflows or browse by category. (e.g. git, android, npm, etc.)
- When a Workflow is selected, you can use
SHIFT-TABto cycle thru the parameters.
How to use Workflows
Workflows solve some major pain points with aliases, specifically the:
- 1.need to context switch
- 1.leave vim, source dotfiles, or reset shell
- 2.difficulty with attaching documentation
- 3.inability to easily search or share
- 4.inability to easily parameterize
Workflows can easily be shared with your team by saving a workflow's YAML file to
.warp/workflows/in the top level of a repository. 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'd into a remote machine.
Local Workflow Path:
Repository Workflow Path:
To start, create a workflows subdirectory within your
mkdir -p ~/.warp/workflows
Add your workflow’s
.yamlfile 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 ~/.warp/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
.yamlfile like so:
mkdir -p .warp/workflows/
cp ~/path/to/my_awesome_workflow.yaml .warp/workflows