rb

--verbose <style> - Output format: plain (simple text), rich (colored/formatted), markdown (markdown formatted)
--summarize - Generate JSON summary of execution results

Examples

spry rb task task-1

Run a specific task.

spry rb task task-1 --verbose rich

Run with detailed colored output.

spry rb task task-1 --summarize

Run with JSON summary of results.

spry rb task task-1 --verbose rich --summarize

Run with all options enabled.

run

Execute all code cells in markdown documents as a DAG (Directed Acyclic Graph).

spry rb run [paths...]

Options

-h, --help - Show help information
--verbose <style> - Emit information messages verbosely
- plain - Plain text output
- rich - Colorized/formatted output
- markdown - Markdown formatted output
--graph <name> - Run only nodes in provided graph(s)
--summarize - Emit summary after execution in JSON format
--visualize <style> - Visualize the DAG before/during execution
- ascii-tree - Tree structure diagram
- ascii-workflow - Workflow sequence diagram
- ascii-flowchart - Detailed flowchart format
- mermaid-js - Mermaid graph syntax

Examples

# Run all tasks in order
spry rb run

# Run from specific file
spry rb run Spryfile.md

# Plain text output
spry rb run --verbose plain

# Colored detailed output
spry rb run --verbose rich

# Markdown formatted output
spry rb run --verbose markdown

# Run only Graph A tasks
spry rb run --graph A

# Run Graphs A and B
spry rb run --graph "A,B"

# Show task tree structure
spry rb run --visualize ascii-tree

# Show workflow sequence
spry rb run --visualize ascii-workflow

# Show detailed flowchart
spry rb run --visualize ascii-flowchart

# Show Mermaid diagram
spry rb run --visualize mermaid-js

# JSON execution summary
spry rb run --summarize

# Output with visualization
spry rb run --verbose rich --visualize ascii-workflow

# Save execution log
spry rb run --verbose rich --summarize > execution.json

issues

Display errors, warnings, and validation issues in markdown documents.

spry rb issues [paths...]

What It Detects

Malformed code block syntax
Invalid task IDs
Circular dependencies
Missing task references
Duplicate task names
Syntax errors

Examples

# Check current file
spry rb issues

# Check specific file
spry rb issues Spryfile.md

# Check all markdown files
spry rb issues *.md

Output

No Issues:

✓ No issues found

With Issues:

Spryfile.md:
  Line 42: ERROR - Circular dependency: task-a → task-b → task-a
  Line 58: WARNING - Undefined task reference 'missing-task'
  Line 75: ERROR - Missing language specifier in code block

Usage Patterns

Validate Before Running

spry rb issues && spry rb run

In Scripts

if spry rb issues > /dev/null; then
  echo "Ready to run"
  spry rb run
else
  echo "Fix issues first"
fi

Always run spry rb issues before executing tasks to catch potential problems early.

report

Execute all code cells and return results as new markdown.

spry rb report [paths...]

Description

Executes all code cells in markdown documents and generates new markdown with embedded outputs. Useful for creating executable documentation and reports with live data.

Examples

# Generate report from current directory
spry rb report

# Generate report from specific file
spry rb report Spryfile.md

# Generate reports from multiple files
spry rb report *.md

Output Example

Before:

```bash
echo "Hello"
```

After:

```bash
echo "Hello"
```
```output
Hello
```

The report command will execute all code cells. Ensure your code is safe to run before generating reports.

How is this guide?

rb

On this page