JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q87309F
  • License MIT

CLI for creating, validating, compiling, and serving Vox documents

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@voxdoc/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    @voxdoc/cli

    CLI for creating, validating, compiling, and serving Vox documents.

    Install

    npm install -g @voxdoc/cli

    Commands

    # Create a new document
    vox init my-doc --title "My Document"
    
    # Validate against schema + accessibility rules
    vox validate my-doc.vox.html
    
    # Recompile (re-renders the self-rendering HTML)
    vox compile my-doc.vox.html
    
    # Show document metadata
    vox info my-doc.vox.html
    
    # List all blocks
    vox blocks my-doc.vox.html
    
    # Start MCP server for AI authoring
    vox mcp serve my-doc.vox.html   # single file
    vox mcp serve ./docs/           # directory
    vox mcp serve                   # dynamic workspace
    
    # Register with Claude (one-time)
    vox mcp install

    How it works

    Vox documents are self-rendering HTML files with embedded JSON source. Double-click a .vox.html file to view it in any browser. AI agents connect via MCP to author documents. Humans review by exception.

    vox init doc.vox.html --title "API Docs"    # creates self-rendering .vox.html
    # open doc.vox.html in browser → see it immediately
    # AI edits via MCP → file re-renders automatically
    vox compile doc.vox.html                     # re-render from embedded source

    License

    MIT — Raiser Software Inc.