Show Commands

Overview

Show commands display repository information in human-readable formats optimized for interactive terminal use. They provide formatted tables, lists, and text designed for visual consumption rather than programmatic processing.

Key Characteristics:

Human-readable formatted output
Tables with aligned columns
Colorized status indicators
Designed for terminal display
Interactive exploration

When to use: During interactive development and troubleshooting when you need to quickly understand repository state.

For automation: Use get commands instead, which provide JSON output.

All Show Commands

Command	Description
show
show approval-comments	Display PR approval comments in human-readable format
show approve-summary	Generate release approval summary
show artifacts	Display artifacts for a module with status
show books	Display all book configurations in a human-readable table
show build-summary	Generate pretty build summary for a module
show build-times	Display build timing metrics in tables
show changelog	Display changelog entries in human-readable format
show ci-summary	Generate CI workflow summary for a module
show component-types	Display all component types grouped by count
show config	Display all loaded configurations with defaults applied
show dependencies	Show module dependency graph in a human-readable table format
show dependency-ci-summary	Generate dependency CI check summary
show deps-setup-summary	Generate dependencies setup summary
show environments	Display all environment configurations
show files	Display all tracked files and their owning modules
show files-changed	Show changed (modified, unstaged) files with their module ownership
show files-staged	Show staged files with their module ownership
show help	Display help information for commands
show modules	Display all module contracts in a human-readable table
show release-notes	Display release notes in human-readable format
show release-summary	Generate release summary from layers JSON
show scan-summary	Generate pretty scan summary for a module
show specs	Display specifications for a release
show suite	Display test suite details with all tests
show test-results
show test-summary	Generate pretty test summary for a module
show test-timings	Display test timing metrics in tables
show tests	Display all test assertions with metadata
show trigger-summary	Generate release trigger summary
show valid-commands	Show all valid commands in a table
show workspaces	List all workspaces and their status

Common Patterns

Table Output

Most show commands display data as formatted tables:

$ r2r eac show modules
┌───────────────┬─────────────┬────────────────────┬──────┐
│ Moniker       │ Type        │ Path               │ Files│
├───────────────┼─────────────┼────────────────────┼──────┤
│ eac-commands  │ go-commands │ go/eac/commands    │   45 │
│ eac-core      │ go-library  │ go/eac/core        │   32 │
│ src-auth      │ go-library  │ go/src/auth        │   18 │
└───────────────┴─────────────┴────────────────────┴──────┘

Features:

Aligned columns
Headers with separators
Auto-truncated long values
Sorted by relevance

Status Indicators

Commands use symbols and colors for status:

✓ Success    (green)
✗ Failed     (red)
⚠ Warning    (yellow)
⋯ Running    (blue)
⊘ Skipped    (gray)

Report Format

Summary commands generate markdown-compatible reports:

# Test Summary: module-name (suite-name)

## Results
✓ Passed: 45
✗ Failed: 2
Total: 47 (95.7% pass rate)

## Performance
- Average: 0.45s
- Total: 21.6s

show vs get Duality

Many show commands have corresponding get commands that provide the same information in JSON format:

show command	get command	Use Case
`show modules`	`get modules`	Module information
`show dependencies`	`get dependencies`	Dependency graph
`show files`	`get files`	File ownership
`show config`	`get config`	Configuration
`show tests`	`get tests`	Test information
`show environments`	`get environments`	Environment contracts
`show build-times`	`get build-times`	Build performance
`show test-timings`	`get test-timings`	Test performance
`show suite <name>`	`get suite <name>`	Test suite details
`show artifacts <m>`	`get artifacts <m>`	Build artifacts
`show valid-commands`	`get valid-commands`	Command list

Rule: Use show for interactive terminal use, get for scripts and automation.

Common Workflows

Exploring the Repository

# Start with modules
r2r eac show modules

# Understand dependencies
r2r eac show dependencies

# See file organization
r2r eac show files

# Check configuration
r2r eac show config

Checking Status

# See what's changed
r2r eac show files-changed

# Check workspaces
r2r eac show workspaces

# View test status
r2r eac show tests

Reviewing Results

# Build summary
r2r eac show build-summary eac-commands

# Test summary
r2r eac show test-summary src-auth acceptance

# Performance analysis
r2r eac show build-times
r2r eac show test-timings

Getting Help

# General help
r2r eac show help

# List all commands
r2r eac show valid-commands

# Command-specific help
r2r eac help <command>

Usage Examples

Module Discovery

# All modules
r2r eac show modules

# Module types
r2r eac show component-types

# Dependency graph
r2r eac show dependencies

File Investigation

# All files (large output)
r2r eac show files

# Changed files only
r2r eac show files-changed

# Staged files only
r2r eac show files-staged

Test Analysis

# All tests
r2r eac show tests

# Specific suite
r2r eac show suite acceptance

# Test performance
r2r eac show test-timings

# Test summary for CI
r2r eac show test-summary src-auth acceptance

Environment Information

# Environments
r2r eac show environments

# Documentation books
r2r eac show books

# Git worktrees
r2r eac show workspaces

Output Customization

Piping to less

For large output, pipe to less:

r2r eac show files | less
r2r eac show tests | less

Filtering with grep

Filter output with grep:

# Find specific module
r2r eac show modules | grep "src-auth"

# Find failed tests
r2r eac show tests | grep "✗"

# Find go-library modules
r2r eac show modules | grep "go-library"

Saving Output

Save formatted output to files:

# Save to file
r2r eac show modules > modules.txt

# Append to log
r2r eac show test-summary src-auth acceptance >> test-report.log

Performance Notes

Fast Commands

These commands execute quickly (< 1s):

show modules
show component-types
show dependencies
show config
show workspaces
show environments
show books

Moderate Commands

These commands may take a few seconds:

show files (loads ~2,690 files)
show tests (scans all test files)
show build-times (parses build logs)
show test-timings (parses test logs)

Expensive Commands

Avoid in tight loops:

show files - Loads all files (~19k tokens)
Use show files-changed or show files-staged instead when possible

Best Practices

Interactive Use

Start with show modules to understand repository structure
Use show commands for exploration rather than scripting
Pipe large output to less for easier navigation
Use grep for filtering when you know what you're looking for

When to Use get Instead

Use get commands when you need to:

Process output with jq or other tools
Cache results for repeated queries
Integrate with CI/CD pipelines
Parse data programmatically

Combining Commands

# Find module, then show its dependencies
MODULE=$(r2r eac show modules | grep "src-auth" | awk '{print $1}')
r2r eac show dependencies | grep "$MODULE"

# Better: use get commands for this
r2r eac get dependencies | jq ".dependencies[\"src-auth\"]"

Common Issues

Output Too Large

Problem: Command output fills the screen

Solution: Pipe to less or filter with grep

r2r eac show files | less
r2r eac show tests | grep "@auth"

Colors Not Working

Problem: No color in output

Solution: Ensure terminal supports colors, or check if output is piped

# Force colors (if supported)
export FORCE_COLOR=1
r2r eac show modules

Table Misaligned

Problem: Table columns don't align

Solution: Ensure terminal is wide enough or use narrower output

# Use get command for narrow terminals
r2r eac get modules | jq -r '.modules[] | "\(.moniker): \(.type)"'