Getting Started

Quick start guide for cleocode

Get up and running with cleocode in minutes.

Step 1: Install

npm install -D @cleocode/monorepo

Step 2: Add TSDoc to your code

Add TSDoc comments to your exported functions and types:

/**
 * Adds two numbers together.
 * @param a - First number
 * @param b - Second number
 * @returns The sum of a and b
 * @example
 * ```typescript
 * const result = add(1, 2); // => 3
 * ```
 */
export function add(a: number, b: number): number {
  return a + b;
}

Step 3: Run forge-ts check

Lint your TSDoc coverage before generating docs:

npx forge-ts check

Expected output:

forge-ts: checking TSDoc coverage...
  ✓ All public symbols documented

Step 4: Generate docs

Build your documentation site:

npx forge-ts build

Your code examples become live documentation:

import { checkStatuslineIntegration } from './statusline.js';

const status = checkStatuslineIntegration();
if (status === 'not_configured') {
  console.log('Run cleo install to set up context monitoring');
}

What’s Next?

• Concepts — Understand how forge-ts works
• API Reference — Full API documentation
• Guides — Practical how-to guides