Skip to main content

softschema/cli

JavaScript / TypeScript API reference for the module softschema/cli.

Public API​

Constant: DOC_TOPICS​

Canonical path: softschema/cli.DOC_TOPICS

Declared in: packages/typescript/src/cli.ts

Signature​

const DOC_TOPICS: DocTopic[] = [
  {
    name: "development",
    title: "Development",
    path: "docs/development.md",
    summary: "Local development workflow.",
  },
  {
    name: "example",
    title: "Movie Page Example",
    path: "examples/movie_page/README.md",
    summary: "Copyable example overview.",
  },
  {
    name: "example-artifact",
    title: "Movie Page Artifact",
    path: "examples/movie_page/spirited-away.md",
    summary: "Copyable Markdown/YAML artifact.",
  },
  {
    name: "example-host",
    title: "Movie Page Host Integration",
    path: "examples/movie_page/host_integration.py",
    summary: "Host registry and validation helper.",
  },
  {
    name: "example-model",
    title: "Movie Page Model",
    path: "examples/movie_page/model.py",
    summary: "Pydantic model used by the example.",
  },
  {
    name: "example-schema",
    title: "Movie Page Compiled Schema",
    path: "examples/movie_page/movie-page.schema.yaml",
    summary: "Compiled JSON Schema for the example.",
  },
  {
    name: "guide",
    title: "softschema Guide",
    path: "docs/softschema-guide.md",
    summary: "Concepts, mental model, and adoption path.",
  },
  {
    name: "installation",
    title: "Installation",
    path: "docs/installation.md",
    summary: "Installing softschema for Node or Python.",
  },
  {
    name: "python-design",
    title: "Python Package Design",
    path: "docs/softschema-python-design.md",
    summary: "Python package design decisions.",
  },
  { name: "readme", title: "README", path: "README.md", summary: "Short first-visitor overview." },
  {
    name: "skill",
    title: "softschema Skill",
    path: "skills/softschema/SKILL.md",
    summary: "Portable agent skill instructions.",
  },
  {
    name: "spec",
    title: "softschema Spec",
    path: "docs/softschema-spec.md",
    summary: "Language-neutral artifact format.",
  },
  {
    name: "typescript-design",
    title: "TypeScript Package Design",
    path: "docs/softschema-typescript-design.md",
    summary: "TypeScript package design decisions.",
  },
]

Constant: SKILL_INSTALL_TARGETS​

Canonical path: softschema/cli.SKILL_INSTALL_TARGETS

Declared in: packages/typescript/src/cli.ts

Signature​

const SKILL_INSTALL_TARGETS = {
  portable: ".agents/skills/softschema/SKILL.md",
  claude: ".claude/skills/softschema/SKILL.md",
} as const

Function: installSkillPayload​

Canonical path: softschema/cli.installSkillPayload

Declared in: packages/typescript/src/cli.ts

Signature​

function installSkillPayload(rendered: string): string {}

Function: isProgrammerBug​

Canonical path: softschema/cli.isProgrammerBug

Declared in: packages/typescript/src/cli.ts

Signature​

function isProgrammerBug(err: unknown): boolean {}

Function: main​

Canonical path: softschema/cli.main

Declared in: packages/typescript/src/cli.ts

Signature​

async function main(argv: string[] = process.argv): Promise<number> {}

Function: reportUserError​

Canonical path: softschema/cli.reportUserError

Declared in: packages/typescript/src/cli.ts

Signature​

function reportUserError(prefix: string, err: unknown): number {}

Interface: DocTopic​

Canonical path: softschema/cli.DocTopic

Declared in: packages/typescript/src/cli.ts

Signature​

interface DocTopic {
  name: string;
  title: string;
  path: string;
  summary: string;
}