Warp Documentation
Search…
Getting Started
Features
Performance
Workflows
Workflows are an easier way to execute and share commands within Warp. They are searchable by name, description, or command and are easily parameterized. A global list of commands sourced by the Warp team and community are readily available within the app. Additionally, you can create and manage local workflows specific to you or associated with a particular git repository.
The in app Workflows menu can be accessed through the Command Palette or by pressing
SHIFT-CTRL-R. Once inside the menu, filter the existing commands by typing in the search bar or click on any of the sections in the side panel to browse by category.
Press SHIFT-CTRL-R to open the Workflows menu.
How is this Different from Aliases?
Power users tend to save aliases, create shell functions, and leverage CLI tools that streamline this. Aliases, however, have major pain points:
- 1.need to context switch
- 1.leave vim, source dotfiles, or reset shell
- 2.it’s difficult to attach documentation
- 3.are not easily searchable or sharable
- 4.are not easily parameterized
Getting aliases and functions to a productive state requires an upfront investment that’s justifiable for devs who spend most of their workday in the terminal but less so for beginners and casual users.
Creating Custom Workflows
In addition to the globally sourced commands, Workflows supports the ability to save commonly used commands specific to you or your team by adding workflows defined in YAML files directly to the
~/.warp/workflows directory or the .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 vs Repository Workflows
Local workflows are specific to a single developer. Repository workflows are instead associated with a specific git repository and can be accessed by anyone who has cloned the repo. Currently, Repository workflows will not appear if you are SSH’d into a remote machine.
Local Workflows:
~/.warp/workflowsRepository Workflows
{{path_to_git_repo}}/.warp/workflowsWorkflows File Format
The existing workflows specs within the Workflows repo should serve as an example for the format. Additionally, a more comprehensive file format is available in FORMAT.md.
Adding a Local Workflow
To start, create a workflows subdirectory within your .warp folder
mkdir -p ~/.warp/workflowsThen, add your command’s yaml file to this directory and Warp should automatically load it into the workflows menu.
cp ~/path/to/my_awesome_workflow.yaml ~/.warp/workflowsAdding a Repository Workflow
You can add a repository workflow exactly like you add a local workflow except now the yaml file should live within the repo’s.
.warp directory. While cd’d into the repo’s root directory run1
cd {{repository_path}}
2
​
3
mkdir -p .warp/workflows
4
​
5
cp ~/path/to/my_awesome_workflow.yaml .warp/workflows
Copied!
Contributing to Global Workflows
You can add workflows that all Warp users can use by contributing directly to the Workflows repo. See the Contributing section for more details.
Last modified 18d ago