Skip to main content
ASK

Installation

Install the ASK CLI and run it against your project.

Installation

Prerequisites

  • Node.js 22.5+ (required for the node:sqlite connector used by some integrations)
  • A package manager (bun, npm, pnpm, or yarn) — ASK reads whichever lockfile is present

Install the CLI

# bun (recommended for this repo)
bun add -d @pleaseai/ask

# npm
npm install -D @pleaseai/ask

# pnpm
pnpm add -D @pleaseai/ask

# yarn
yarn add -D @pleaseai/ask

Or run ad-hoc without installing:

bunx @pleaseai/ask docs zod
npx @pleaseai/ask docs zod

First run

Declare libraries in ask.json:

{
  "libraries": [
    "npm:next",
    "npm:zod",
    { "spec": "github:tanstack/intent", "ref": "v0.5.0" }
  ]
}

Then resolve, fetch, and wire everything up:

ask install

This will:

  1. Resolve every entry against the project's lockfile (or the pinned ref for github specs).
  2. Fetch docs into .ask/docs/<name>@<version>/ (gitignored).
  3. Write a Claude Code skill at .claude/skills/<name>-docs/SKILL.md.
  4. Regenerate the <!-- BEGIN:ask-docs-auto-generated --> block in AGENTS.md.

One-shot reads

No ask.json required:

# Candidate doc directories (one per line)
ask docs zod

# Cached checkout root (single path)
ask src facebook/react

# Producer-shipped skills
ask skills list vercel/ai

All three commands share a single cache at ~/.ask/ (override with ASK_HOME).

Introduction