@travetto/doc 8.0.0-alpha.2 → 8.0.0-alpha.21

package/src/mapping/module.ts

@@ -1,222 +1,338 @@
 export const MODULES = {
   Auth: {
-    name: '@travetto/auth', folder: '@travetto/auth', displayName: 'Authentication',
-    description: 'Authentication scaffolding for the Travetto framework'
+    name: '@travetto/auth',
+    folder: '@travetto/auth',
+    displayName: 'Authentication',
+    description: 'Authentication support for the Travetto framework'
   },
   AuthModel: {
-    name: '@travetto/auth-model', folder: '@travetto/auth-model', displayName: 'Authentication Model',
+    name: '@travetto/auth-model',
+    folder: '@travetto/auth-model',
+    displayName: 'Authentication Model',
     description: 'Authentication model support for the Travetto framework'
   },
   AuthSession: {
-    name: '@travetto/auth-session', folder: '@travetto/auth-session', displayName: 'Auth Session',
+    name: '@travetto/auth-session',
+    folder: '@travetto/auth-session',
+    displayName: 'Auth Session',
     description: 'Session provider for the travetto auth module.'
   },
   AuthWeb: {
-    name: '@travetto/auth-web', folder: '@travetto/auth-web', displayName: 'Web Auth',
+    name: '@travetto/auth-web',
+    folder: '@travetto/auth-web',
+    displayName: 'Web Auth',
     description: 'Web authentication integration support for the Travetto framework'
   },
   AuthWebPassport: {
-    name: '@travetto/auth-web-passport', folder: '@travetto/auth-web-passport', displayName: 'Web Auth Passport',
+    name: '@travetto/auth-web-passport',
+    folder: '@travetto/auth-web-passport',
+    displayName: 'Web Auth Passport',
     description: 'Web authentication integration support for the Travetto framework'
   },
   AuthWebSession: {
-    name: '@travetto/auth-web-session', folder: '@travetto/auth-web-session', displayName: 'Web Auth Session',
+    name: '@travetto/auth-web-session',
+    folder: '@travetto/auth-web-session',
+    displayName: 'Web Auth Session',
     description: 'Web authentication session integration support for the Travetto framework'
   },
   Cache: {
-    name: '@travetto/cache', folder: '@travetto/cache', displayName: 'Caching',
+    name: '@travetto/cache',
+    folder: '@travetto/cache',
+    displayName: 'Caching',
     description: 'Caching functionality with decorators for declarative use.'
   },
   Cli: {
-    name: '@travetto/cli', folder: '@travetto/cli', displayName: 'Command Line Interface',
+    name: '@travetto/cli',
+    folder: '@travetto/cli',
+    displayName: 'Command Line Interface',
     description: 'CLI infrastructure for Travetto framework'
   },
   Compiler: {
-    name: '@travetto/compiler', folder: '@travetto/compiler', displayName: 'Compiler',
+    name: '@travetto/compiler',
+    folder: '@travetto/compiler',
+    displayName: 'Compiler',
     description: 'The compiler infrastructure for the Travetto framework'
   },
   Config: {
-    name: '@travetto/config', folder: '@travetto/config', displayName: 'Configuration',
+    name: '@travetto/config',
+    folder: '@travetto/config',
+    displayName: 'Configuration',
     description: 'Configuration support'
   },
   Context: {
-    name: '@travetto/context', folder: '@travetto/context', displayName: 'Async Context',
+    name: '@travetto/context',
+    folder: '@travetto/context',
+    displayName: 'Async Context',
     description: 'Async-aware state management, maintaining context across asynchronous calls.'
   },
   Di: {
-    name: '@travetto/di', folder: '@travetto/di', displayName: 'Dependency Injection',
+    name: '@travetto/di',
+    folder: '@travetto/di',
+    displayName: 'Dependency Injection',
     description: 'Dependency registration/management and injection support.'
   },
   Doc: {
-    name: '@travetto/doc', folder: '@travetto/doc', displayName: 'Documentation',
+    name: '@travetto/doc',
+    folder: '@travetto/doc',
+    displayName: 'Documentation',
     description: 'Documentation support for the Travetto framework'
   },
   Email: {
-    name: '@travetto/email', folder: '@travetto/email', displayName: 'Email',
+    name: '@travetto/email',
+    folder: '@travetto/email',
+    displayName: 'Email',
     description: 'Email transmission module.'
   },
   EmailCompiler: {
-    name: '@travetto/email-compiler', folder: '@travetto/email-compiler', displayName: 'Email Compilation Support',
+    name: '@travetto/email-compiler',
+    folder: '@travetto/email-compiler',
+    displayName: 'Email Compilation Support',
     description: 'Email compiling module'
   },
   EmailInky: {
-    name: '@travetto/email-inky', folder: '@travetto/email-inky', displayName: 'Email Inky Templates',
+    name: '@travetto/email-inky',
+    folder: '@travetto/email-inky',
+    displayName: 'Email Inky Templates',
     description: 'Email Inky templating module'
   },
   EmailNodemailer: {
-    name: '@travetto/email-nodemailer', folder: '@travetto/email-nodemailer', displayName: 'Email Nodemailer Support',
+    name: '@travetto/email-nodemailer',
+    folder: '@travetto/email-nodemailer',
+    displayName: 'Email Nodemailer Support',
     description: 'Email transmission module.'
   },
-  Eslint: {
-    name: '@travetto/eslint', folder: '@travetto/eslint', displayName: 'ES Linting Rules',
-    description: 'ES Linting Rules'
+  Lint: {
+    name: '@travetto/lint',
+    folder: '@travetto/lint',
+    displayName: 'Lint Support',
+    description: 'Lint Support'
   },
   Image: {
-    name: '@travetto/image', folder: '@travetto/image', displayName: 'Image',
+    name: '@travetto/image',
+    folder: '@travetto/image',
+    displayName: 'Image',
     description: 'Image support, resizing, and optimization'
   },
+  LlmSupport: {
+    name: '@travetto/llm-support',
+    folder: '@travetto/llm-support',
+    displayName: 'LLM Support',
+    description: 'Task-oriented synthesized LLM guidance for Travetto modules.'
+  },
   Log: {
-    name: '@travetto/log', folder: '@travetto/log', displayName: 'Logging',
+    name: '@travetto/log',
+    folder: '@travetto/log',
+    displayName: 'Logging',
     description: 'Logging framework that integrates at the console.log level.'
   },
   Manifest: {
-    name: '@travetto/manifest', folder: '@travetto/manifest', displayName: 'Manifest',
+    name: '@travetto/manifest',
+    folder: '@travetto/manifest',
+    displayName: 'Manifest',
     description: 'Support for project indexing, manifesting, along with file watching'
   },
   Model: {
-    name: '@travetto/model', folder: '@travetto/model', displayName: 'Data Modeling Support',
+    name: '@travetto/model',
+    folder: '@travetto/model',
+    displayName: 'Data Modeling Support',
     description: 'Datastore abstraction for core operations.'
   },
   ModelDynamodb: {
-    name: '@travetto/model-dynamodb', folder: '@travetto/model-dynamodb', displayName: 'DynamoDB Model Support',
+    name: '@travetto/model-dynamodb',
+    folder: '@travetto/model-dynamodb',
+    displayName: 'DynamoDB Model Support',
     description: 'DynamoDB backing for the travetto model module.'
   },
   ModelElasticsearch: {
-    name: '@travetto/model-elasticsearch', folder: '@travetto/model-elasticsearch', displayName: 'Elasticsearch Model Source',
+    name: '@travetto/model-elasticsearch',
+    folder: '@travetto/model-elasticsearch',
+    displayName: 'Elasticsearch Model Source',
     description: 'Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.'
   },
   ModelFile: {
-    name: '@travetto/model-file', folder: '@travetto/model-file', displayName: 'File Model Support',
+    name: '@travetto/model-file',
+    folder: '@travetto/model-file',
+    displayName: 'File Model Support',
     description: 'File system backing for the travetto model module.'
   },
   ModelFirestore: {
-    name: '@travetto/model-firestore', folder: '@travetto/model-firestore', displayName: 'Firestore Model Support',
+    name: '@travetto/model-firestore',
+    folder: '@travetto/model-firestore',
+    displayName: 'Firestore Model Support',
     description: 'Firestore backing for the travetto model module.'
   },
+  ModelIndexed: {
+    name: '@travetto/model-indexed',
+    folder: '@travetto/model-indexed',
+    displayName: 'Data Model Indexing Support',
+    description: 'Basic indexing support for model sources that support it.'
+  },
   ModelMemory: {
-    name: '@travetto/model-memory', folder: '@travetto/model-memory', displayName: 'Memory Model Support',
+    name: '@travetto/model-memory',
+    folder: '@travetto/model-memory',
+    displayName: 'Memory Model Support',
     description: 'Memory backing for the travetto model module.'
   },
   ModelMongo: {
-    name: '@travetto/model-mongo', folder: '@travetto/model-mongo', displayName: 'MongoDB Model Support',
+    name: '@travetto/model-mongo',
+    folder: '@travetto/model-mongo',
+    displayName: 'MongoDB Model Support',
     description: 'Mongo backing for the travetto model module.'
   },
   ModelMysql: {
-    name: '@travetto/model-mysql', folder: '@travetto/model-mysql', displayName: 'MySQL Model Service',
+    name: '@travetto/model-mysql',
+    folder: '@travetto/model-mysql',
+    displayName: 'MySQL Model Service',
     description: 'MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.'
   },
   ModelPostgres: {
-    name: '@travetto/model-postgres', folder: '@travetto/model-postgres', displayName: 'PostgreSQL Model Service',
+    name: '@travetto/model-postgres',
+    folder: '@travetto/model-postgres',
+    displayName: 'PostgreSQL Model Service',
     description: 'PostgreSQL backing for the travetto model module, with real-time modeling support for SQL schemas.'
   },
   ModelQuery: {
-    name: '@travetto/model-query', folder: '@travetto/model-query', displayName: 'Data Model Querying',
+    name: '@travetto/model-query',
+    folder: '@travetto/model-query',
+    displayName: 'Data Model Querying',
     description: 'Datastore abstraction for advanced query support.'
   },
   ModelQueryLanguage: {
-    name: '@travetto/model-query-language', folder: '@travetto/model-query-language', displayName: 'Data Model Query Language',
+    name: '@travetto/model-query-language',
+    folder: '@travetto/model-query-language',
+    displayName: 'Data Model Query Language',
     description: 'Datastore query language.'
   },
   ModelRedis: {
-    name: '@travetto/model-redis', folder: '@travetto/model-redis', displayName: 'Redis Model Support',
+    name: '@travetto/model-redis',
+    folder: '@travetto/model-redis',
+    displayName: 'Redis Model Support',
     description: 'Redis backing for the travetto model module.'
   },
   ModelS3: {
-    name: '@travetto/model-s3', folder: '@travetto/model-s3', displayName: 'S3 Model Support',
+    name: '@travetto/model-s3',
+    folder: '@travetto/model-s3',
+    displayName: 'S3 Model Support',
     description: 'S3 backing for the travetto model module.'
   },
   ModelSql: {
-    name: '@travetto/model-sql', folder: '@travetto/model-sql', displayName: 'SQL Model Service',
+    name: '@travetto/model-sql',
+    folder: '@travetto/model-sql',
+    displayName: 'SQL Model Service',
     description: 'SQL backing for the travetto model module, with real-time modeling support for SQL schemas.'
   },
   ModelSqlite: {
-    name: '@travetto/model-sqlite', folder: '@travetto/model-sqlite', displayName: 'SQLite Model Service',
+    name: '@travetto/model-sqlite',
+    folder: '@travetto/model-sqlite',
+    displayName: 'SQLite Model Service',
     description: 'SQLite backing for the travetto model module, with real-time modeling support for SQL schemas.'
   },
   Openapi: {
-    name: '@travetto/openapi', folder: '@travetto/openapi', displayName: 'OpenAPI Specification',
+    name: '@travetto/openapi',
+    folder: '@travetto/openapi',
+    displayName: 'OpenAPI Specification',
     description: 'OpenAPI integration support for the Travetto framework'
   },
   Pack: {
-    name: '@travetto/pack', folder: '@travetto/pack', displayName: 'Pack',
+    name: '@travetto/pack',
+    folder: '@travetto/pack',
+    displayName: 'Pack',
     description: 'Code packing utilities'
   },
   Registry: {
-    name: '@travetto/registry', folder: '@travetto/registry', displayName: 'Registry',
+    name: '@travetto/registry',
+    folder: '@travetto/registry',
+    displayName: 'Registry',
     description: 'Patterns and utilities for handling registration of metadata and functionality for run-time use'
   },
   Repo: {
-    name: '@travetto/repo', folder: '@travetto/repo', displayName: 'Repo',
+    name: '@travetto/repo',
+    folder: '@travetto/repo',
+    displayName: 'Repo',
     description: 'Monorepo utilities'
   },
   Runtime: {
-    name: '@travetto/runtime', folder: '@travetto/runtime', displayName: 'Runtime',
+    name: '@travetto/runtime',
+    folder: '@travetto/runtime',
+    displayName: 'Runtime',
     description: 'Runtime for travetto applications.'
   },
-  Scaffold: {
-    name: '@travetto/scaffold', folder: '@travetto/scaffold', displayName: 'App Scaffold',
-    description: 'App Scaffold for the Travetto framework'
-  },
   Schema: {
-    name: '@travetto/schema', folder: '@travetto/schema', displayName: 'Schema',
+    name: '@travetto/schema',
+    folder: '@travetto/schema',
+    displayName: 'Schema',
     description: 'Data type registry for runtime validation, reflection and binding.'
   },
   SchemaFaker: {
-    name: '@travetto/schema-faker', folder: '@travetto/schema-faker', displayName: 'Schema Faker',
+    name: '@travetto/schema-faker',
+    folder: '@travetto/schema-faker',
+    displayName: 'Schema Faker',
     description: 'Data generation for schema-registered objects.'
   },
   Terminal: {
-    name: '@travetto/terminal', folder: '@travetto/terminal', displayName: 'Terminal',
+    name: '@travetto/terminal',
+    folder: '@travetto/terminal',
+    displayName: 'Terminal',
     description: 'General terminal support'
   },
   Test: {
-    name: '@travetto/test', folder: '@travetto/test', displayName: 'Testing',
+    name: '@travetto/test',
+    folder: '@travetto/test',
+    displayName: 'Testing',
     description: 'Declarative test framework'
   },
   TodoApp: {
-    name: '@travetto/todo-app', folder: '@travetto/todo-app', displayName: 'Todo Application',
+    name: '@travetto/todo-app',
+    folder: '@travetto/todo-app',
+    displayName: 'Todo Application',
     description: ''
   },
   Transformer: {
-    name: '@travetto/transformer', folder: '@travetto/transformer', displayName: 'Transformation',
+    name: '@travetto/transformer',
+    folder: '@travetto/transformer',
+    displayName: 'Transformation',
     description: 'Functionality for AST transformations, with transformer registration, and general utils'
   },
   Web: {
-    name: '@travetto/web', folder: '@travetto/web', displayName: 'Web API',
+    name: '@travetto/web',
+    folder: '@travetto/web',
+    displayName: 'Web API',
     description: 'Declarative support for creating Web Applications'
   },
   WebAwsLambda: {
-    name: '@travetto/web-aws-lambda', folder: '@travetto/web-aws-lambda', displayName: 'Web AWS Lambda',
+    name: '@travetto/web-aws-lambda',
+    folder: '@travetto/web-aws-lambda',
+    displayName: 'Web AWS Lambda',
     description: 'Web APIs entry point support for AWS Lambdas.'
   },
   WebConnect: {
-    name: '@travetto/web-connect', folder: '@travetto/web-connect', displayName: 'Web Connect Support',
+    name: '@travetto/web-connect',
+    folder: '@travetto/web-connect',
+    displayName: 'Web Connect Support',
     description: 'Web integration for Connect-Like Resources'
   },
   WebHttp: {
-    name: '@travetto/web-http', folder: '@travetto/web-http', displayName: 'Web HTTP Server Support',
+    name: '@travetto/web-http',
+    folder: '@travetto/web-http',
+    displayName: 'Web HTTP Server Support',
     description: 'Web HTTP Server Support'
   },
   WebRpc: {
-    name: '@travetto/web-rpc', folder: '@travetto/web-rpc', displayName: 'Web RPC Support',
+    name: '@travetto/web-rpc',
+    folder: '@travetto/web-rpc',
+    displayName: 'Web RPC Support',
     description: 'RPC support for a Web Application'
   },
   WebUpload: {
-    name: '@travetto/web-upload', folder: '@travetto/web-upload', displayName: 'Web Upload Support',
+    name: '@travetto/web-upload',
+    folder: '@travetto/web-upload',
+    displayName: 'Web Upload Support',
     description: 'Provides integration between the travetto asset and web module.'
   },
   Worker: {
-    name: '@travetto/worker', folder: '@travetto/worker', displayName: 'Worker',
+    name: '@travetto/worker',
+    folder: '@travetto/worker',
+    displayName: 'Worker',
     description: 'Process management utilities, with a focus on inter-process communication'
   }
 };

package/src/render/code-highlight.ts

@@ -33,12 +33,11 @@ export function highlight(text: string, lang: string): string | undefined {
     indent: 0
   });
 
-  text = text
-    .replace(/&#(\d+);/g, (_, code) => String.fromCharCode(code))
-    .replace(/&[a-z][^;]*;/g, a => tokenMapping[a] || a);
+  text = text.replace(/&#(\d+);/g, (_, code) => String.fromCharCode(code)).replace(/&[a-z][^;]*;/g, a => tokenMapping[a] || a);
 
   try {
-    return prismJs.highlight(text, prismJs.languages[lang], lang)
+    return prismJs
+      .highlight(text, prismJs.languages[lang], lang)
       .replace(/(@\s*<span[^>]*)function("\s*>)/g, (a, pre, post) => `${pre}meta${post}`)
       .replace(/[{}]/g, a => `{{'${a}'}}`);
   } catch (error) {
@@ -49,4 +48,3 @@ export function highlight(text: string, lang: string): string | undefined {
     }
   }
 }
-

package/src/render/context.ts

@@ -1,18 +1,19 @@
 import path from 'node:path';
 
+import { CliCommandRegistryIndex } from '@travetto/cli';
 import { PackageUtil } from '@travetto/manifest';
-import { castTo, RuntimeIndex } from '@travetto/runtime';
+import { type Class, castTo, RuntimeIndex } from '@travetto/runtime';
+import { SchemaRegistryIndex } from '@travetto/schema';
 
-import { type JSXElementByFn, c, d } from '../jsx.ts';
+import { createElement, JSXRuntimeTag } from '../../support/jsx-runtime.ts';
+import { c, d, type JSXElementByFn } from '../jsx.ts';
 import { DocResolveUtil, type ResolvedCode, type ResolvedRef, type ResolvedSnippetLink } from '../util/resolve.ts';
 import { DocRunUtil } from '../util/run.ts';
-import { createElement, JSXRuntimeTag } from '../../support/jsx-runtime.ts';
 
 /**
  * Render Context
  */
 export class RenderContext {
-
   #executeCache: Record<string, string> = {};
 
   /**
@@ -36,7 +37,6 @@ export class RenderContext {
   repoRoot: string;
 
   constructor(file: string, baseUrl: string, repoRoot: string) {
-
     const manifestPkg = PackageUtil.readPackage(RuntimeIndex.getModule('@travetto/manifest')!.sourcePath);
 
     this.file = path.resolve(file);
@@ -62,9 +62,10 @@ export class RenderContext {
   /**
    * Generate link location
    */
-  link(text: string, line?: number | { [key: string]: unknown, line?: number }): string {
+  link(text: string, line?: number | { [key: string]: unknown; line?: number }): string {
     const num = typeof line === 'number' ? line : line?.line;
-    return `${text.replace(this.repoRoot, this.baseUrl)
+    return `${text
+      .replace(this.repoRoot, this.baseUrl)
       .replace(/.*@travetto\//, `${this.travettoBaseUrl}/module/`)}${num && num > 1 ? `#L${num}` : ''}`;
   }
 
@@ -79,7 +80,12 @@ export class RenderContext {
    * Get a consistent anchor id
    */
   getAnchorId(a: string): string {
-    return a.toLowerCase().replace(/<[^>]+>/g, ' ').replace(/[^a-z0-9]+/g, ' ').trim().replace(/ /g, '-');
+    return a
+      .toLowerCase()
+      .replace(/<[^>]+>/g, ' ')
+      .replace(/[^a-z0-9]+/g, ' ')
+      .trim()
+      .replace(/ /g, '-');
   }
 
   /**
@@ -93,7 +99,16 @@ export class RenderContext {
 
     const { cmd, args = [], config = {} } = node.props;
     const result = await DocRunUtil.run(cmd, args, config);
-    return this.#executeCache[key] = result;
+    return (this.#executeCache[key] = result);
+  }
+
+  /**
+   * Resolve CLI command metadata for a class from cli:schema output.
+   */
+  resolveCliCommandFromClass(commandClass: Class): { name: string; description?: string } {
+    const { name } = CliCommandRegistryIndex.get(commandClass);
+    const { description } = SchemaRegistryIndex.getConfig(commandClass);
+    return { name, description };
   }
 
   /**
@@ -114,9 +129,9 @@ export class RenderContext {
    * Resolve code/config
    */
   async resolveCode(node: JSXElementByFn<'Code' | 'Config'>): Promise<ResolvedCode> {
-    return node.props.startRe ?
-      DocResolveUtil.resolveSnippet(node.props.src, node.props.startRe, node.props.endRe, node.props.outline) :
-      DocResolveUtil.resolveCode(node.props.src, node.props.language, node.props.outline);
+    return node.props.startRe
+      ? DocResolveUtil.resolveSnippet(node.props.src, node.props.startRe, node.props.endRe, node.props.outline)
+      : DocResolveUtil.resolveCode(node.props.src, node.props.language, node.props.outline);
   }
 
   /**
@@ -126,4 +141,4 @@ export class RenderContext {
     // @ts-expect-error
     return castTo(createElement(c[name], props));
   }
-}
+}

package/src/render/html.ts

@@ -1,20 +1,24 @@
 import fs from 'node:fs/promises';
 
-import { Runtime, RuntimeIndex } from '@travetto/runtime';
+import markdown from 'markdown-it';
+
+import { HELP_FLAG } from '@travetto/cli';
 import { PackageUtil } from '@travetto/manifest';
+import { CodecUtil, Runtime, RuntimeError, RuntimeIndex } from '@travetto/runtime';
 
-import { highlight } from './code-highlight.ts';
-import type { RenderProvider, RenderState } from '../types.ts';
+import type { JSXElement } from '../../support/jsx-runtime.ts';
 import { c, getComponentName } from '../jsx.ts';
-import { MODULES } from '../mapping/module.ts';
 import { LIBRARIES } from '../mapping/library.ts';
-import type { RenderContext } from './context.ts';
-import { DocResolveUtil } from '../util/resolve.ts';
-import type { JSXElement } from '../../support/jsx-runtime.ts';
+import { MODULES } from '../mapping/module.ts';
+import type { RenderProvider, RenderState } from '../types.ts';
 import { PackageDocUtil } from '../util/package.ts';
+import { DocResolveUtil } from '../util/resolve.ts';
+import { highlight } from './code-highlight.ts';
+import type { RenderContext } from './context.ts';
 
 const ESCAPE_ENTITIES: Record<string, string> = { '<': '&lt;', '>': '&gt;', '&': '&amp;', '{': "{{'{'}}", '}': "{{'}'}}" };
 const ENTITY_REGEX = new RegExp(`[${Object.keys(ESCAPE_ENTITIES).join('')}]`, 'gm');
+const md = new markdown({ html: false });
 
 const stdInline = async ({ recurse, node }: RenderState<JSXElement, RenderContext>): Promise<string> =>
   `<${node.type}>${await recurse()}</${node.type}>`;
@@ -36,14 +40,23 @@ export const Html: RenderProvider<RenderContext> = {
   },
   br: async () => '<br><br>\n',
   hr: async () => '<hr>\n',
-  strong: stdInline, em: stdInline,
-  h2: stdFull, h3: stdFull, h4: stdFull,
-  li: std, ol: stdFull, ul: stdFull,
-  table: stdFull, thead: std, tr: std, td: std, tbody: std,
+  strong: stdInline,
+  em: stdInline,
+  h2: stdFull,
+  h3: stdFull,
+  h4: stdFull,
+  li: std,
+  ol: stdFull,
+  ul: stdFull,
+  table: stdFull,
+  thead: std,
+  tr: std,
+  td: std,
+  tbody: std,
   Execution: async ({ context, node, props, createState }) => {
     const output = await context.execute(node);
-    const displayCmd = props.config?.formatCommand?.(props.cmd, props.args ?? []) ??
-      `${node.props.cmd} ${(node.props.args ?? []).join(' ')}`;
+    const displayCmd =
+      props.config?.formatCommand?.(props.cmd, props.args ?? []) ?? `${node.props.cmd} ${(node.props.args ?? []).join(' ')}`;
     const sub = createState('Terminal', {
       language: 'bash',
       title: props.title,
@@ -51,10 +64,39 @@ export const Html: RenderProvider<RenderContext> = {
     });
     return Html.Terminal(sub);
   },
+  CliHelpExecution: async ({ context, props, createState }) => {
+    const config = context.resolveCliCommandFromClass(props.commandClass);
+    const { name: command } = config;
+    return Html.Execution(
+      createState('Execution', {
+        title: `Showing help for ${command}`,
+        cmd: 'trv',
+        args: [command, HELP_FLAG],
+        config: { ...props.config }
+      })
+    );
+  },
+  CliHelpDescription: async ({ context, props }) => {
+    const config = context.resolveCliCommandFromClass(props.commandClass);
+    let text = config.description ?? '';
+    if (props.short) {
+      text = CodecUtil.readFirstLine(text);
+    }
+    return md.render(text);
+  },
+  CliHelpSection: async ({ context, props, recurse }) => {
+    const config = context.resolveCliCommandFromClass(props.commandClass);
+    const { name: command } = config;
+    const title = `CLI - ${command}`;
+    return `\n<h2 id="${context.getAnchorId(title)}">${title}</h2>\n\n${await recurse()}`;
+  },
   Install: async ({ context, node }) => {
-    const highlighted = highlight(`
+    const highlighted = highlight(
+      `
 ${PackageDocUtil.getInstallInstructions(node.props.pkg, true)}
-`, 'bash');
+`,
+      'bash'
+    );
 
     return `\n
   <figure class="install">
@@ -74,7 +116,7 @@ ${PackageDocUtil.getInstallInstructions(node.props.pkg, true)}
     const content = await context.resolveCode(node);
     let link: string = '';
     if ('src' in props && content.file) {
-      let linkCtx: { file: string, line?: number } = { file: content.file! };
+      let linkCtx: { file: string; line?: number } = { file: content.file! };
       if (props.startRe) {
         linkCtx = await DocResolveUtil.resolveCodeLink(linkCtx.file, props.startRe);
       }
@@ -121,11 +163,10 @@ ${PackageDocUtil.getInstallInstructions(node.props.pkg, true)}
     `<a class="anchor-link" routerLink="." fragment="${context.getAnchorId(props.href)}">${props.title}</a>`,
 
   File: state => Html.Ref(state),
-  Ref: async ({ context, props }) =>
-    `<a target="_blank" class="source-link" href="${context.link(props.href, props)}">${props.title}</a>`,
+  Ref: async ({ context, props }) => `<a target="_blank" class="source-link" href="${context.link(props.href, props)}">${props.title}</a>`,
   Image: async ({ context, props }) => {
-    if (!/^https?:/.test(props.href) && !(await fs.stat(props.href).catch(() => false))) {
-      throw new Error(`${props.href} is not a valid location`);
+    if (!/^https?:/.test(props.href) && !(await fs.stat(props.href, { throwIfNoEntry: false }))) {
+      throw new RuntimeError(`${props.href} is not a valid location`);
     }
     return `<img src="${context.link(props.href, props)}" alt="${props.title}">`;
   },
@@ -151,10 +192,10 @@ ${PackageDocUtil.getInstallInstructions(node.props.pkg, true)}
     if (state.node.props.install !== false) {
       const sub = state.createState('Install', {
         title: pkg.name,
-        pkg: pkg.name,
+        pkg: pkg.name
       });
       install = await Html.Install(sub);
     }
     return `<h1>${title}${desc ? `\n<small>${desc}</small>\n` : ''}</h1>\n${install}\n`;
   }
-};
+};