# AGENTS.md

Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors

## Setup

```
pnpm install
```

## Commands

```
pnpm build          # produce a build
pnpm test           # run the test suite, must pass before any commit
pnpm typecheck      # type check without emitting
pnpm lint           # lint
pnpm format         # format
pnpm build:sdk
pnpm build:mcp
pnpm build:ai-sdk
```

## Layout

- `packages/` 108 source files

## Conventions

- Tests live alongside the code they cover, following `packages/cli/src/__tests__/auth-commands.test.ts`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/canary-release.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Copy `.env.example` before running anything that needs configuration.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.