Skip to content

feat: add workflows inspect command with detailed workflow information #285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Angelmmiguel merged 3 commits into from
Nov 10, 2025
Merged

feat: add workflows inspect command with detailed workflow information #285

Angelmmiguel merged 3 commits into from
Nov 10, 2025

Conversation

@Angelmmiguel
Copy link
Contributor

@Angelmmiguel Angelmmiguel commented Nov 6, 2025 •
edited
Loading

Add a new rover workflows inspect <workflow-name> command to display detailed information about a specific workflow. This helps users understand workflow structure, inputs, outputs, and execution flow before creating tasks.

The command provides three output modes: regular formatted display with visual step diagrams, JSON output for programmatic access, and raw YAML output for viewing the complete workflow definition.

I adapted the output from #270 to use existing patterns defined in ./docs/cli-guidelines.md.

Closes #270

Changes

  • Added inspectWorkflowCommand() in packages/cli/src/commands/workflows/inspect.ts with support for regular, JSON, and raw YAML output modes
  • Registered rover workflows inspect <workflow-name> command in workflows command group
  • Implemented visual step diagram using the new showDiagram() utility from rover-common
  • Added metadata display for workflow name, description, version, defaults (tool, model), and config (timeout, continueOnError)
  • Exported showDiagram from rover-common for CLI usage

Demo

$ rover workflows inspect tech-writer
Rover (v1.4.1) · /home/angel/Workspace/rover
--------------------------------------------

Workflow Details
----------------
· Name: tech-writer
· Description: Write documentation and tutorials for your technical projects
· Version: 1.0
· Timeout: 3600s
· Continue On Error: No

Inputs
------
· description: Define the documentation you want me to write (required)
· audience: Describe the target audience for this documentation (default: end users)
· format: What is the file format you want the documentation? (default: markdown)

Outputs
-------
· documentation: Final implementation or tutorial
· context: Technical context analysis
· outline: Documentation outline

Steps
-----
╭ Context Analysis ──╮
│ → context_file     │
╰────────────────────╯
           ↓
╭ Outline ───────────╮
│ → outline_file     │
╰────────────────────╯
           ↓
╭ Draft ─────────────╮
│ → draft_file       │
╰────────────────────╯
           ↓
╭ Review ────────────╮
│ → document_file    │
│ → summary_file     │
╰────────────────────╯

@Angelmmiguel Angelmmiguel self-assigned this Nov 6, 2025
@Angelmmiguel Angelmmiguel added this to the v1.5 milestone Nov 6, 2025
@Angelmmiguel Angelmmiguel merged commit 4e2bdb4 into main Nov 10, 2025
4 checks passed
@Angelmmiguel Angelmmiguel deleted the 270/workflow-inspect branch December 5, 2025 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ereslibre ereslibre ereslibre approved these changes

Assignees

@Angelmmiguel Angelmmiguel

Labels

None yet

Projects

None yet

Milestone

v1.5

Development

Successfully merging this pull request may close these issues.

Inspect workflow command

3 participants

@Angelmmiguel @ereslibre