Skip to content

Commit 74ee5f4

Browse files
authored
feat: add workflows documentation and update CLI reference (#31)
1 parent ca2bbe9 commit 74ee5f4

3 files changed

Lines changed: 530 additions & 28 deletions

File tree

src/content/docs/rover/concepts/workflow.mdx

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,26 +59,26 @@ rover logs <task-id>
5959
# 🚀 Running Workflow
6060
# =======================================
6161
# Loading inputs from /inputs.json
62-
#
62+
#
6363
# Agent Workflow
6464
# ├── Name: tech-writer
6565
# └── Description: Write documentation and tutorials for your technical projects
66-
#
66+
#
6767
# User inputs
6868
# ├── title=Document rover.json and settings.json configuration files
6969
# ├── description=Create high-level documentation explaining the purpose ...
7070
# ├── audience=end users (default)
7171
# └── format=markdown (default)
72-
#
72+
#
7373
# Steps
7474
# ├── 0. Context Analysis
7575
# ├── 1. Outline
7676
# ├── 2. Draft
7777
# └── 3. Review
78-
#
78+
#
7979
# 🤖 Running Context Analysis > claude
8080
# ✓ Step 'Context Analysis' completed successfully
81-
#
81+
#
8282
# 📊 Step Results: Context Analysis
8383
# ├── ID: context
8484
# ├── Status: ✓ Success
@@ -93,11 +93,35 @@ rover logs <task-id>
9393

9494
## Custom Workflows
9595

96+
You can adapt workflows that are Rover built-in, or you can create workflows of your own. Custom workflows can either be saved to the global store, or local to current project. By default, workflows are added locally to the current project, but you can use the `--global` flag to refer to the global workflows when you are in a project.
97+
98+
Custom workflows are required to follow the [Workflow YAML file format documented here](/rover/reference/workflow-file/).
99+
100+
If you want to start from an existing workflow, you can first dump its contents to a file in the filesystem:
101+
102+
```sh
103+
rover workflows inspect swe --raw > improved-swe.yaml
104+
```
105+
106+
Make the changes you want on the `improved-swe.yaml`, and import it.
107+
108+
```sh
109+
rover workflows add --name improved-swe improved-swe.yaml
110+
```
111+
112+
You can now refer to this workflow normally, for example:
113+
114+
```sh
115+
rover task --workflow improved-swe 'Improve the installation script to check that the user has root permissions'
116+
```
117+
118+
You can follow the [`Write workflows` guide](/rover/guides/write-workflows) in order to create your own workflows that accomodate your custom use cases or needs.
119+
96120
## Next Steps
97121

98122
<CardGrid>
99123
<LinkCard title="Overview" href="/rover/intro/overview" description="Get started with the Rover CLI" />
100124
<LinkCard title="Task" href="/rover/concepts/task" description="Learn about Rover tasks and how to manage them" />
101125
<LinkCard title="Sandbox" href="/rover/concepts/sandbox" description="Understand the sandboxed environment where tasks run" />
102126
<LinkCard title="Workspace" href="/rover/concepts/workspace" description="Explore the workspace where coding agents apply changes" />
103-
</CardGrid>
127+
</CardGrid>

0 commit comments

Comments
 (0)