Axiom Web-UI
The Axiom Web-UI is an interactive web interface built into the Spry platform to visualize, explore, and interact with Spry Ontology Graphs (SOGs) and Markdown-based mdAST structures. It serves as the graphical environment for inspecting ontology models, relationships, documentation graphs, workflow structures, and real-time introspection of Spry-based knowledge graphs.
The Web-UI provides a rich, browser-based visual exploration layer on top of the Spry Ontology engine, enabling developers, analysts, and documentation authors to graphically understand and navigate interconnected domain concepts without needing to manually inspect JSON or command-line output.
Installation and Initialization
Section titled “Installation and Initialization”Install Deno 2.5 or higher and bootstrap your project:
cd <your-project>deno run --node-modules-dir=auto -A https://raw.githubusercontent.com/programmablemd/spry/main/lib/sqlpage/cli.ts init./spry.ts helpThis creates:
spry.ts- Executable wrapper to run Spry commands locallySpryfile.md- Executable Markdown defining tasks, SQL, and routes
Use Web-UI Service
Section titled “Use Web-UI Service”After the Installation and Initialization To use the service commands, spry.ts content should be changed like:
#!/usr/bin/env -S deno run -A --node-modules-dir=auto// Use `deno run -A --watch` in the shebang if you're contributing / developing Spry itself.
import { CLI } from "../../../lib/axiom/text-ui/cli.ts";
await new CLI({ defaultFiles: ["Qualityfolio.md"] }).run();Commands
Section titled “Commands”1. help [command] - Show this help or the help of a sub-command
Section titled “1. help [command] - Show this help or the help of a sub-command”The help command is used to view general usage guidance for the CLI or to display detailed help information for a specific sub-command. It provides descriptions and available options to assist users in understanding how to run each command.
Usage:
./spry.ts help2. completions - Generate shell completions
Section titled “2. completions - Generate shell completions”The completions command generates auto-completion scripts for supported shells such as bash, zsh, or fish. Shell completions make the command-line interface more user-friendly by enabling features like:
Command suggestions as you type
Auto-completing command names and options when pressing Tab
Reducing typing errors and speeding up workflow
Usage:
./spry.ts completions [shell]Example:
./spry.ts completions bash./spry.ts completions fish./spry.ts completions zsh
./spry.ts completions bash --name myspry3. web-ui [paths…] - Serve the markdown mdasts and Spry Ontology Graphs (SOGs)
Section titled “3. web-ui [paths…] - Serve the markdown mdasts and Spry Ontology Graphs (SOGs)”The web-ui command launches an interactive browser-based interface for visualizing Spry Ontology Graphs (SOGs) and Markdown document structures (mdASTs). When executed, it starts a local web server and renders the selected files or directories as interactive graphs and document trees.
This tool is useful for exploring knowledge models, documentation structures, and graph relationships visually instead of using raw CLI or JSON outputs.
Usage:
./spry.ts web-ui [paths...]Example:
./spry.ts web-ui ./Spryfile.md