For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /packs/shared/documentation/quickstarts.md.
Quick start

Quick starts

A quick start proves the first useful result. It should take the reader from prerequisites to working local context without asking them to design a pack first.

Shortest working path

Why

A beginner cannot choose between several source formats before seeing an installation work. One selected path establishes the result that later guides can expand.

Rules

  • MUST state What you will build before the steps. [review]
  • MUST list the runtime, package manager, working directory, and required initial state. [review]
  • MUST use at most five numbered steps. [review]
  • MUST keep each executable block complete and valid for the stated working directory. [review]
  • MUST make the Result section show an observable success condition. [review]
  • MUST send alternatives and detailed explanation to linked Next steps. [review]
  • MUST identify source-workspace commands when the released package does not yet implement the example. [review]
  • SHOULD use a disposable consumer for demonstrations that create config, lock, or installed files. [review]

Example structure

This example models the checked-in CLI, not a claim about an npm release.

# Install your first context pack

## What you will build

A temporary consumer with local reference material and a locked installation.

## Prerequisites

Run from a Granary checkout with Node.js 26+ and its pinned pnpm version.

## 1. Prepare the workspace

```sh
pnpm install
pnpm build
```

## 2. Install into a fresh consumer

```sh
CONSUMER="$(mktemp -d)"
pnpm cli add "$PWD" --pack recommended-typescript --cwd "$CONSUMER"
```

## 3. Restore recorded content

```sh
pnpm cli install --cwd "$CONSUMER"
```

## Result

```sh
pnpm cli list --cwd "$CONSUMER"
```

Expect the standards identity, its content version, and the `docs` group.

## Next steps

Read the installed index, then choose a guide for authoring or selecting content.

[review]

Component-content tests check standard metadata and heading structure. Review verifies the five-step limit, named task sections, clean-consumer starting state, and observed result.

See Guides for task variations and Tutorials for learning-oriented explanations.

Enforcement

Component-content tests check standard metadata and heading structure. Review verifies the five-step limit, named task sections, clean-consumer starting state, and observed result.

See Guides for task variations and Tutorials for learning-oriented explanations.