CLI Commands

Command Overview

The Spry CLI provides commands for managing executable Markdown notebooks, SQLPage content, and task orchestration.

General Commands

• spry help - Display help information for the CLI
• spry -h - Display help information for the CLI
• spry --version - Show the current version number
• spry -V - Show the current version number

axiom Commands

• spry axiom web-ui - Start Web UI with default file on default port

• spry axiom web-ui Spryfile.md - Show document hierarchy

• spry axiom web-ui docs/*.md - Show hierarchy for all docs of docs directory

• spry axiom web-ui --port 9090 - Start on custom port

• spry axiom web-ui docs/*.md --port 9090 - Start all document files of docs directory on custom port

• spry axiom web-ui --listen 127.0.0.1 - Specify network interface

• spry axiom web-ui --no-open - Start without opening browser

• spry axiom web-ui docs/*.md --no-open - Start all document files of docs directory without opening browser

• spry axiom ls - List all nodes in default document

• spry axiom ls Spryfile.md - List all nodes in Spryfile

• spry axiom ls README.md docs/guide.md - List nodes from multiple files

• spry axiom ls docs/*.md - List nodes from all Markdown files in docs directory

• spry axiom ls -n paragraph - Include additional node types

• spry axiom ls --node paragraph - Include additional node types

• spry axiom ls docs/*.md -n paragraph - Include additional node types for all files of docs directory

• spry axiom ls docs/*.md --node paragraph - Include additional node types for all files

• spry axiom ls --no-color - List default file without colors

• spry axiom ls docs/*.md --no-color - List all files of docs directory without colors

• spry axiom inspect - Inspect default file

• spry axiom inspect docs/*.md - Inspect all files in docs directory

• spry axiom inspect --no-color - Inspect default file without colors

• spry axiom inspect --no-color docs/*.md - Inspect all files in docs directory without colors

• spry axiom projection - Generate projection from default file

• spry axiom projection docs/*.md - Generate projection from all files

• spry axiom projection --pretty - Pretty-print JSON output of default

• spry axiom projection docs/*.md --pretty - Pretty-print JSON output of all files

• spry axiom projection --jsonl - Generate JSONL (JSON Lines) output of default file

• spry axiom projection --jsonl docs/*.md - Generate JSONL (JSON Lines) output of all files

• spry axiom shebang - Add shebang to default file

• spry axiom shebang docs/*.md - Add shebang to all files in docs directory

• spry axiom shebang --dry-run - Preview without modifying (dry-run)

• spry axiom shebang docs/*.md --dry-run - Preview without modifying the files in docs directory (dry-run)

• spry axiom shebang --entrypoint ./cli.ts - Specify custom entrypoint (default is ./cli.ts)

• spry axiom shebang docs/*.md --entrypoint ./cli.ts - Specify custom entrypoint for all files in docs directory (default

rb Commands

• spry rb run - Execute all code cells in default markdown documents as a DAG (Directed Acyclic Graph).

• spry rb run Spryfile.md - Execute all code cells in Spryfile.md as a DAG (Directed Acyclic Graph).

• spry rb run --verbose plain - Plain text output.

• spry rb run --verbose rich - Colored detailed output

• spry rb run --verbose markdown -Markdown formatted output

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

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

• spry rb run --summarize - JSON execution summary

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

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

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

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

• spry rb issues - Check default file (Spryfile.md) for issues

• spry rb issues Spryfile.md - Check specific file Spryfile.md for issues

• spry rb issues docs/*.md - Check all markdown files of docs directory

• spry rb tap - Execute all code cells as DAG and emit TAP (Test Anything Protocol)

• spry rb tap --save test.tap - Execute all code cells and save results in test.tap file

• spry rb tap --style html --save test.tap.html - Execute all code cells and emit the results in HTML style to the test.tap.html file.

• spry rb tap --style markdown --save test.tap.md - Execute all code cells and emit the results in Markdown style to the test.tap.md file.

• spry rb tap --style json --save test.tap.json - Execute all code cells and emit the results in JSON style to the test.tap.json file.

• spry rb tap --graph rowcounts --style html --save test.tap.html - Execute only the nodes in provided graph rowcounts and emit the results in HTML style to the test.tap.html file.

• spry rb tap --graph rowcounts --style markdown --save test.tap.md - Execute only the nodes in provided graph rowcounts and emit the results in Markdown style to the test.tap.md file.

• spry rb tap --graph rowcounts --style json --save test.tap.json - Execute only the nodes in provided graph rowcounts and emit the results in JSON style to the test.tap.json file.

• spry rb report - Generate report from default directory/file

• spry rb report Spryfile.md - Generate report from specific file

• spry rb report docs/*.md - Generate reports from all files of docs directory

• spry rb task task-1 --verbose rich - Execute with verbose output and summary

• spry rb task task-1 --summarize - Run with JSON summary of results.

• spry rb task task-1 --verbose rich --summarize - Execute with verbose output and summary

• spry rb report > test.md - Execute all code cells and return result into test.md.

• spry rb report --graph rowcounts > test.rowcounts.md - Execute only the nodes in provided graph rowcounts and return result into test.rowcounts.md`.

SP Commands

• spry sp init - Initialize Spryfile.md and import_map.json for local development (default SQLite)
• spry sp init --dialect postgres - Initialize with PostgreSQL (default SQLite)
• spry sp init --force - Force reinitialize

SQLPage Content generation and management:

Package Generation

• spry sp spc --package - Generate SQL package for SQLite
• spry sp spc --package --dialect postgres - Generate SQL package for PostgreSQL

File Materialization

• spry sp spc --fs dev-src.auto --conf sqlpage/sqlpage.json - Materialize files with config file
• spry sp spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json - Clean build (remove existing files first)

Development Mode

• spry sp spc --fs dev-src.auto --conf sqlpage/sqlpage.json --watch - Watch mode with auto-rebuild
• spry sp spc --fs dev-src.auto --conf sqlpage/sqlpage.json --destroy-first --watch --with-sqlpage - Watch mode with SQLPage server
• spry sp spc --fs dev-src.auto --conf sqlpage/sqlpage.json --watch --with-sqlpage --sqlpage-bin /usr/local/bin/sqlpage - Watch mode with custom SQLPage binary

Database Deployment

• spry sp spc --package | sqlite3 app.db - Deploy to SQLite database
• spry sp spc --package --dialect postgres | psql $DATABASE_URL - Deploy to PostgreSQL
• spry sp spc --package --dialect postgres | psql postgresql://user:pass@host:5432/db - Deploy to remote PostgreSQL

File Operations

• spry sp spc ls - List SQLPage files
• spry sp spc cat -g "*.sql" - Show file contents matching glob pattern

Command Structure

All commands follow this pattern:

spry [command] [subcommand] [options] [arguments]