CLI

leadtype <command> [options]

Six commands: init scaffolds an integration into an existing app, generate runs the full pipeline, sync clones or refreshes the remote sources declared by collections, lint validates content, mcp serves the generated docs to an MCP client over stdio, and score rates the generated build's agent readiness. Run leadtype help <command> for inline usage.

init

Scaffold an agent-ready docs integration into an existing app: a starter docs/ source, the framework's docs route and markdown route, config, and (unless --no-generate) a first run of generate so the site works immediately.

leadtype init [options]

Exit codes: 0 success, 2 CLI usage error or no framework detected. Existing files are never overwritten unless --force is passed. TanStack Start and Fumadocs are not scaffolded by init (heavier app-specific setup) — follow their recipes in Use the source primitive.

generate

Convert MDX, then either produce website artifacts (default) or a package bundle (--bundle).

leadtype generate [options]

Exit codes: 0 success, 1 runtime error (docs dir missing, config load error, unknown group, conversion error, sync failure), 2 CLI usage error.

When the project root has a leadtype.config.{ts,js,mjs,cjs} that declares collections, --docs-dir is rejected (collections fully describe their sources). The legacy --docs-dir shape stays available for projects without a collections config.

Config loading

leadtype generate looks for a project-level leadtype.config.{ts,js,mjs,cjs} at the directory passed to --src (defaults to cwd). If that file exists and defines collections, the collections pipeline runs.

Otherwise — or as a fallback — leadtype loads docs.config.{ts,js,mjs,cjs} from each --docs-dir (<src>/<docs-dir>/docs.config.ts). This is the legacy single-folder shape and is unchanged.

import { defineDocsConfig } from "leadtype";

export default defineDocsConfig({
  product: {
    name: "My Library",
    tagline: "A library that does one thing well.",
  },
  navigation: [
    "index",
    "quickstart",
    { title: "Reference", pages: [{ include: "reference/*" }] },
  ],
  git: {
    ignoredAuthors: ["Docs Automation"],
  },
});

The config supplies product metadata, curated navigation structure, best starting points, and agent guidance. Legacy groups are still supported for fallback navigation and taxonomy. If a page names a legacy group that is not in the loaded config, generation fails in fallback mode.

git.ignoredAuthors adds project-specific author names that should be skipped when leadtype generate derives lastAuthor from git history. Built-in bot detection still applies, and lastModified remains tied to the latest commit.

If no config file exists, the CLI falls back to package.json for product metadata and infers groups from the union of group: values across the generated pages. Inferred groups are sorted alphabetically and title-cased. Use docs.config.ts navigation when sidebar order, nested sections, or wildcard includes matter.

Multiple source folders

Repeat --docs-dir when a project keeps related agent-readable content outside the main docs folder, such as a sibling changelog:

leadtype generate \
  --src . \
  --docs-dir docs \
  --docs-dir changelog \
  --out public

The first source folder is mounted at the generated docs root. Additional source folders are mounted under their folder name, so changelog/v1.mdx becomes public/docs/changelog/v1.md and /docs/changelog/v1.md. --include and --exclude still match docs-root-relative paths after that merge, for example --include "changelog/**".

Use <dir>=<url-prefix> when a source should have its own public URL prefix:

leadtype generate \
  --src . \
  --docs-dir docs \
  --docs-dir changelog=/changelog \
  --out public

That keeps the internal generated copy at public/docs/changelog/v1.md for search and runtime helpers, also writes a static markdown mirror at public/changelog/v1.md, and emits canonical links such as /changelog/v1.md in llms.txt, search metadata, sitemap entries, and agent-readability.json.

Configured feeds

Add feeds to docs.config.ts or leadtype.config.ts when a URL-prefixed content set should publish RSS or Atom. Feeds are generic: use them for a changelog, blog, release notes, news, or any other generated pages selected by canonical URL prefix.

For a task-focused walkthrough, see Generate RSS and Atom feeds.

export default defineDocsConfig({
  product: {
    name: "My Library",
    tagline: "A library that does one thing well.",
  },
  navigation: [
    "index",
    { title: "Changelog", base: "changelog", pages: [{ include: "*" }] },
  ],
  mounts: [{ pathPrefix: "changelog", urlPrefix: "/changelog" }],
  feeds: [
    {
      id: "changelog",
      title: "My Library Changelog",
      description: "Release notes and product updates for My Library.",
      source: { urlPrefix: "/changelog" },
      formats: ["rss", "atom"],
      output: {
        rss: "/changelog/rss.xml",
        atom: "/changelog/atom.xml",
      },
    },
  ],
});

Feeds are site-mode only and require a base URL so item links are absolute. Pass --base-url, or set the same deployment URL environment variables used by the rest of site-mode generation, such as NEXT_PUBLIC_SITE_URL or Vercel URL variables. If neither is set and Leadtype would fall back to an implicit localhost URL, feed generation fails instead of publishing accidental local links. Entries use generated markdown frontmatter: title, description, date, and draft. Every selected page must carry a date or lastModified-style field (add one in frontmatter, or let default git enrichment write lastModified when history is available); generation fails otherwise so feed entries never inherit unstable build-time file timestamps. Pages with draft: true are excluded. Output paths must end in .xml and be unique across feeds so a feed can never overwrite another generated artifact. A source.urlPrefix of / selects every generated page; otherwise the exact prefix page and its child pages are selected. Atom feeds set the feed-level author from product.name.

Bundle mode

leadtype generate --bundle --src . --out packages/my-package

Writes <out>/AGENTS.md (relative-link index, agent-discoverable) plus <out>/docs/*.md (one per page, group subdirs preserved). Skips every URL-anchored artifact (llms.txt, llms-full.txt, sitemap, robots) — those are website-only. Use this for npm packages that ship docs alongside the published code; see Bundle docs into a package.

If docs.config.ts sets agents.mcp.enabled, bundle mode also emits docs/search-index.json + docs/agent-readability.json. These are URL-independent (the MCP server keys on urlPath and reads the .md mirror), so they work without a --base-url. A consumer who installs the package can then run a version-matched docs MCP server with leadtype mcp --package <name> — no separate hosting. The old --mcp shortcut still works for compatibility, but it is deprecated and should not be used in new scripts. See the MCP server reference.

JSON output shape

--json prints a single object describing what was generated. The shape varies by mode:

{
  "mode": "site",
  "srcDir": "/abs/path/to/repo",
  "docsDir": "/abs/path/to/repo/docs",
  "docsDirs": ["/abs/path/to/repo/docs"],
  "outDir": "/abs/path/to/repo/public",
  "product": { "name": "...", "summary": "..." },
  "groups": [{ "slug": "get-started", "title": "Get Started" }],
  "filters": { "include": [], "exclude": [] },
  "mounts": [{ "pathPrefix": "", "urlPrefix": "/docs" }],
  "files": {
    "llmsTxt": "/abs/path/.../public/llms.txt",
    "wellKnownLlmsTxt": "/abs/path/.../public/.well-known/llms.txt",
    "docsLlmsTxt": "/abs/path/.../public/docs/llms.txt",
    "llmsFullTxt": "/abs/path/.../public/llms-full.txt",
    "searchIndex": "/abs/path/.../public/docs/search-index.json",
    "searchContent": "/abs/path/.../public/docs/search-content.json",
    "sitemapXml": "/abs/path/.../public/sitemap.xml",
    "sitemapMd": "/abs/path/.../public/sitemap.md",
    "robotsTxt": "/abs/path/.../public/robots.txt",
    "agentReadabilityManifest": "/abs/path/.../public/docs/agent-readability.json",
    "agentSkills": "/abs/path/.../public/.well-known/agent-skills/index.json",
    "feeds": {
      "changelog": {
        "rss": "/abs/path/.../public/changelog/rss.xml",
        "atom": "/abs/path/.../public/changelog/atom.xml"
      }
    }
  },
  "search": { /* index stats */ }
}

The root sitemap and robots files are the crawler-facing defaults. Host apps that merge docs pages with blog, marketing, changelog, or product pages can override those root files or use the runtime helpers to serve merged responses.

In --bundle mode, mode is "bundle" and files always contains agentsMd. URL-anchored site fields (llmsTxt, sitemap, robots, etc.) are absent. When MCP is enabled through agents.mcp.enabled or --mcp, files also includes searchIndex, searchContent, and agentReadabilityManifest.

Errors in JSON mode print {"error": "...", ...} to stderr.

Custom script config

Custom build scripts do not auto-discover config. Import docs.config.ts directly and pass the values to the lower-level APIs:

import { generateLlmsTxt } from "leadtype/llm";
import { generateFeedArtifacts } from "leadtype/feed";
import docsConfig from "../docs/docs.config";

await generateLlmsTxt({
  srcDir: process.cwd(),
  outDir: "public",
  baseUrl: "https://leadtype.dev",
  product: docsConfig.product,
  nav: docsConfig.navigation,
});

await generateFeedArtifacts({
  outDir: "public",
  baseUrl: "https://leadtype.dev",
  feeds: docsConfig.feeds,
  mounts: docsConfig.mounts,
});

See LLM files for the rest of the script.

sync

Clone or refresh the remote sources declared by collections in a project-level leadtype.config.{ts,js,mjs,cjs}. Local-only collections are no-ops.

leadtype sync [options]

Exit codes: 0 all targeted sources are ready, 1 sync failure (clone error, offline cache miss, git not installed), 2 configuration or usage error (no leadtype.config.* found, no collections to sync, unknown flag, mutually exclusive flags).

Sync modes at a glance

Cache layout

Each remote collection's clone lives at <cacheDir> (default .leadtype/sources/<repo-slug>@<ref>, relative to the config dir). Override per collection with cacheDir when other tooling needs a stable on-disk path, such as a docs extractor that reads generated fixtures from the cloned repo.

Inside each cacheDir, leadtype sync writes a .leadtype-sync.json manifest:

{
  "version": 1,
  "repository": "https://github.com/c15t/c15t",
  "ref": "main",
  "commit": "abc1234…",
  "syncedAt": "2026-05-15T04:52:39.287Z"
}

leadtype generate reads this on subsequent runs to decide whether the cache is current. Manual git pull inside a cacheDir won't invalidate the manifest — run leadtype sync --refresh instead.

Sharing one clone across collections

Two collections that point at the same (repository, ref) share a single clone. The sync engine dedupes by repo+ref before issuing any git operations, so this:

const c15t = { repository: "https://github.com/c15t/c15t", ref: "main" } as const;
collections: {
  docs:      defineCollection({ ...c15t, dir: "docs",      prefix: "/docs" }),
  changelog: defineCollection({ ...c15t, dir: "changelog", prefix: "/changelog" }),
}

…runs exactly one git clone, with both collections reading from <cacheDir>/docs and <cacheDir>/changelog.

For a split-repo docs UI, add sourceConfig: true to a remote collection. After sync, generation loads the source repo's docs.config.{ts,js,mjs,cjs} from the collection dir and inherits source-owned navigation, legacy groups, frontmatterSchema, flatteners, and mounts. Keep site-owned fields such as product, organization, agents, llms, output paths, and framework routes in the docs UI repo's leadtype.config.ts.

lint

Validate frontmatter, meta.json, and internal links before generation runs.

leadtype lint [srcDir] [options]

Exit codes: 0 no errors and warnings within budget, 1 lint errors or budget exceeded, 2 CLI usage error.

Default ignored paths: **/shared/**, **/_shared/**, **/_partials/**, **/node_modules/**. Pass --ignore to extend (each pass overrides the defaults — re-add what you need).

See Lint reference for the full rule list, schema, and how to plug in custom Valibot schemas via the library API.

mcp

Serve the generated docs to a local MCP client (Claude Desktop, Cursor, Cline) over stdio. Reads the artifacts generate writes — it never builds them. See the MCP server reference for the hosted-endpoint variant (createMcpHandler) and the IDE config snippets.

leadtype mcp [options]

Exit codes: 0 the server ran and the client disconnected (or --check succeeded), 1 failed to load artifacts (run leadtype generate first) or start the server, 2 CLI usage error.

Test without a client. leadtype mcp --check --query "your term" loads the artifacts, runs search-docs + get-page once, and prints what came back — no editor config, no @modelcontextprotocol/sdk. For a full MCP client UI, point the MCP Inspector at it: npx @modelcontextprotocol/inspector leadtype mcp --artifacts ./public.

Requires the optional peer dependency @modelcontextprotocol/sdk; a missing install surfaces an actionable error. The server reads artifacts only — get-page serves the .md mirror from disk, so a deleted mirror makes pages unreadable even when search still works. Regenerate to restore it.

score

Rate the leadtype-addressable agent readiness of a generated build, mapped to the ora rubric, so you can coach toward a high external scan. Run leadtype generate first, then leadtype score.

leadtype score [options]

Exit codes: 0 scored (and at/above --min if set), 1 below --min, 2 CLI usage error.

It scores what leadtype emits + your doc structure — a local proxy for the external scan, never live answer-engine ranking. Two dimensions are scored (0–100): Identity (llms.txt + .well-known, search index + manifest, sitemap/robots + Content-Signal, JSON-LD readiness, description coverage, and the geo:* structure signals) and Agent Integration (MCP-ready artifacts, the skills surface, offline docs). Discovery, Auth & Access, and User Experience are shown but excluded — answer-engine recall is brand/training, auth is your backend, MCP Apps need UI — so a high score never implies ranking leadtype can't measure. Each missing signal prints the concrete fix. Also available as a library: leadtype/score → scoreDocs.

help

Show usage:

leadtype help            # main usage
leadtype help generate
leadtype help lint
leadtype help mcp
leadtype help score

Library entry points

The CLI is a thin wrapper. Every command is also available as a TypeScript API for custom build scripts:

• leadtype/convert — convertAllMdx, convertMdxToMarkdown, writeMdxFileAsMarkdown.
• leadtype/llm — generateLlmsTxt, generateLLMFullContextFiles, generateAgentReadabilityArtifacts, generateAgentsMd, resolveDocsNavigation.
• leadtype/feed — generateFeedArtifacts, renderRssFeed, and renderAtomFeed.
• leadtype/llm/readability — JSON-LD, markdown response, frontmatter, and agent request helpers for hosted docs sites.
• leadtype/search/node — generateDocsSearchFiles.
• leadtype/lint — lintDocs.
• leadtype/remark — defaultRemarkPlugins and individual plugins.
• leadtype/mcp — createMcpHandler, runStdioServer for the docs MCP server.
• leadtype/score — scoreDocs for the agent-readiness score (the leadtype score command).

Use the CLI for the happy path, the library entry points when you need custom plugin order, base URL precedence, or alternate output paths.