Getting Started

Index is designed for deliberate setup. Gather the workspace facts first, generate the files in one command, then replace starter copy with source-backed context.

Generation Flow

1. 1

   Choose the profile. Pick the workspace shape that matches the work: company brain, client workspace, repo intelligence, automation workspace, or public template.

2. 2

   Generate the files. Run the CLI with explicit flags so the output is deterministic and reviewable.

3. 3

   Replace placeholders with evidence. Add owners, source links, dates, decisions, runbooks, and repo facts that a teammate can verify.

4. 4

   Validate before handoff. Run the checks that match the surfaces changed before agents or teammates rely on the workspace.

Create A Company Brain

node generator/create-index.mjs \
  --name "Acme Brain" \
  --slug acme-brain \
  --output ./acme-brain \
  --profile company-brain \
  --owner "Acme Ops" \
  --services github,slack,notion,linear \
  --skip-install

create-index is non-interactive by default. Agents should ask missing setup questions first, then run one complete command instead of creating partial workspaces.

Choose A Profile

Profile	Purpose
public-template	Public reusable index template with docs, repo registry, workspaces, AI evals, and MCP starter files.
company-brain	Private company brain with repository registry, workspace metadata, automation runbooks, evals, MCP, operating model, roadmap, and intake prompt.
client-workspace	Private delivery workspace for client work, repository intelligence, runbooks, and evals.
repo-intelligence	Internal workspace for mapping codebases, evidence trails, and MCP-accessible repo context.
automation-workspace	Internal workspace for recurring agent and script runbooks with workspace records and evals.

After Generation

• Review README.md, AGENTS.md, and the generated docs before treating the workspace as live.
• Fill repos/index.yaml with real repositories, owners, stacks, status, tags, and start-here files.
• Add workspace records under workspaces/ when the profile includes structured metadata.
• Run the relevant checks from Validation.

Next, review the Feature Map to see what each generated surface is responsible for.