Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.supermodeltools.com/llms.txt

Use this file to discover all available pages before exploring further.

Generates a static HTML site documenting the architecture of a codebase. The command uploads the repository to the Supermodel API, converts the returned code graph to markdown, and builds a browsable static site with search, dependency graphs, taxonomy navigation, and SEO metadata. The site also emits machine-readable artifacts (JSON-LD and llms.txt) alongside the HTML. The output directory can be served locally or deployed to any static host (GitHub Pages, Vercel, Netlify, Cloudflare Pages).

​
Synopsis

supermodel docs [path] [flags]

​
Flags

FlagDescription
-o, --outputOutput directory (default ./docs-output)
--repoGitHub repo slug owner/repo for source links
--base-urlCanonical base URL where the site will be hosted (default https://example.com)
--site-nameDisplay title for the generated site (default <repo> Architecture Docs)
--max-entitiesCap on entity pages (default 12000, 0 = unlimited)
--max-source-filesCap on source files in analysis (default 3000, 0 = unlimited)
--templates-dirOverride bundled HTML/CSS/JS templates with a custom directory
--forceBypass cache and re-upload even if a cached result exists
-h, --helpHelp for docs

​
Examples

supermodel docs

supermodel docs ./my-project --output ./docs-site

supermodel docs --repo owner/repo --base-url https://owner.github.io/repo

supermodel docs --site-name "My App Docs" --output /var/www/html