@aihu/cli

function appAboutAihu(appName: string = 'app'): string

src/pages/about.aihu — a second route, emitted by the `full` template to demonstrate the router resolving more than one page.

function appAihuConfig(): string

aihu.config.ts — kept for server/SSR config; optional for client-only apps.

function appDefaultLayout(): string

src/layouts/default.aihu for Hello World (v1 syntax).

function appDocsGuideAihu(appName: string = 'app'): string

src/pages/guide.aihu — second docs route for the `docs` template.

function appDocsIndexAihu(appName: string = 'app'): string

src/pages/index.aihu for the `docs` template — a docs-flavored landing page.

function appIndexAihu(appName: string = 'app', withCssEngine = false): string

src/pages/index.aihu for Hello World (v1 syntax).

function appIndexHtml(name: string): string

index.html for a new aihu application.

function appMainTs(_name: string): string

src/main.ts entry point for a new aihu app.

function appPackageJson( name: string, pm: PkgManager = 'bun', withCssEngine = false, ): string

package.json for a new aihu application.

function appTsConfig(): string

tsconfig.json for a new aihu application.

function appViteConfig( appName = 'app', withCssEngine = false, shadowMode?: ShadowChoice, ): string

vite.config.ts for a new aihu application (`minimal` and `docs`).

function appVscodeExtensions(): string

.vscode/extensions.json — recommends the aihu language extension.

function appVscodeSettings(): string

.vscode/settings.json — file associations and editor wiring for .aihu.

function componentAihu(name: string): string

A component file for a given component name.

function pageAihu(routePath: string): string

A page file for a given route path.

function pluginIndex(name: string): string

src/index.ts for a new aihu plugin.

function pluginPackageJson(name: string): string

package.json for a new aihu plugin.

function scaffoldApp( name: string, outDir?: string, opts?: { pm?: PkgManager template?: AppTemplate /** `'engine'` includes `@aihu/css-engine` OOTB; `'none'` (default) is the plain scaffold. */ css?: CssChoice /** * Explicit shadow-mode choice when css-engine is opted in. `undefined` * (default) emits NO plugin-global `css: { shadowMode }` block, so the * DA4 framework defaults apply (pages/layouts light, leaves shadow) — * only a genuine user choice is written out (FEL-425). */ shadowMode?: ShadowChoice | undefined /** * Coding-assistant files (AGENTS.md, CLAUDE.md, .mcp.json) — on by * default, `--no-agent-tooling` opts out. This governs ONLY the * developer-environment files; the app's own runtime agent surface * (`$action`, llms.txt, the cards) is the product thesis and is never * affected by this flag. */ agentTooling?: boolean }, ): ScaffoldResult

Scaffold a new aihu application at `<outDir>/<name>/`.

function scaffoldComponent(name: string, outDir?: string): ScaffoldResult

Scaffold a component file under `src/components/`.

function scaffoldPage(routePath: string, outDir?: string): ScaffoldResult

Scaffold a page file under `src/pages/`.

function scaffoldPlugin(name: string, outDir?: string): ScaffoldResult

Scaffold a plugin package directory.

function toKebab(name: string): string

function toSafe(name: string): string

Convert a project name to a safe JS identifier (for use as rolldown input key or custom-element tag name component).

function validateManifest(obj: unknown): TemplateManifest

Validate an arbitrary value as a TemplateManifest.

interface ConditionalDep {
  readonly version: string
  readonly when: string
}

interface ConditionalFile {
  readonly path: string
  readonly when: string
  /** F-5b: when set, the scaffolded file is written with this filename
   * (relative to the same directory as `path`) instead of the source filename.
   * Enables e.g. `.env.example.better-auth` → `.env.example`. */
  readonly rename?: string
}

interface OverridableField {
  readonly choices: ReadonlyArray<ChoiceValue>
  readonly default: ChoiceValue
}

interface PostInstallStep {
  readonly kind: PostInstallKind
  readonly when?: string
  readonly allowFailure?: boolean
}

interface ScaffoldResult {
  /** Files that were written. */
  readonly created: ReadonlyArray<string>
  /** Files skipped because they already existed. */
  readonly skipped: ReadonlyArray<string>
}

interface TemplateManifest {
  readonly name: string
  readonly displayName: string
  readonly description: string
  readonly contractVersion: number
  readonly cliRange: string
  readonly fixed: Readonly<Record<string, ChoiceValue>>
  readonly overridable: Readonly<Record<string, OverridableField>>
  readonly conditionalFiles: ReadonlyArray<ConditionalFile>
  readonly placeholders: ReadonlyArray<string>
  readonly postInstall: ReadonlyArray<PostInstallStep>
  readonly appPeerDeps: Readonly<Record<string, string>>
  readonly appPeerDepsConditional?: Readonly<Record<string, ConditionalDep>>
}

type AppTemplate = 'minimal' | 'full' | 'docs' | 'agent' | 'ssr'

type ChoiceValue = string | boolean

type CssChoice = 'engine' | 'none'

Out-of-the-box CSS strategy for a scaffolded app.

type PkgManager = 'bun' | 'pnpm' | 'npm' | 'yarn'

type PostInstallKind = 'pm-install' | 'git-init' | 'lint-fix' | 'aihu-check'

type ShadowChoice = 'light' | 'shadow'

Shadow-DOM mode threaded into the compiler when css-engine is opted in.