---
title: "Ghost: AGENTS.md"
description: "Example AGENTS.md: Repository instructions for AI coding agents working on the Smithers Bun/TypeScript codebase, its docs, examples, and tests."
---

# AGENTS.md

AGENTS.md sits at the repo root and is auto-injected into every AI coding session. It tells agents what the repo is, what commands to run, and what conventions to follow.

<Note>
**Ghost doc**: A reference example of what `AGENTS.md` contains for the Smithers repository.
</Note>

## Source

````markdown
# Smithers Repository: Agent Instructions

You are working in the Smithers repository, a Bun/TypeScript codebase centered on the `smithers-orchestrator` package.

## Repository Overview

- **Core runtime**: `packages/`, the Smithers workflow engine (`packages/engine/`), JSX components (`packages/components/`), CLI (`apps/cli/`), integrations, and observability
- **Docs**: `docs/`, Mintlify source docs
- **Examples**: `examples/`, runnable TSX workflows
- **Tests**: `packages/*/tests/` for Bun unit/integration tests; `e2e/` for the e2e harness; `apps/smithers-studio-2/` for Playwright e2e
- **Apps**: `apps/`, with Studio (`apps/smithers-studio-2/`), CLI (`apps/cli/`), observability, demos

## Common Commands

From the repository root:

```bash
pnpm test
bun run typecheck
bun run docs
pnpm -C apps/smithers-studio-2 e2e
```

From `apps/smithers-studio-2/`:

```bash
bun run dev
bun run dev:desktop
bun run typecheck
```

## Key Conventions

- The published package name is `smithers-orchestrator`, not `smithers`
- The main public JSX API is `createSmithers(...)`
- Source docs live under `docs/`; `docs/llms-full.txt` is generated from those pages
- `examples/` should stay runnable against the current public API
- The repo may be used from Git or JJ-based workspaces depending on the developer environment; do not assume one workflow unless the local task requires it
````
