<!-- generated by epythet -->

# For AI agents

`falaw` ships artifacts for coding agents alongside its code. This page lists
them, says where each lives in the repository, and points at the
machine-readable copies of this documentation.

## Skills

Skills are folders holding a `SKILL.md` (the [Agent Skills](https://agentskills.io) format): a description that tells an agent when to use it and a body with the procedure. Install one into your agent with `gh skill` (any host: `--agent claude-code`, `copilot`, `cursor`, `codex`, `gemini`), or use the copy bundled in the wheel.

### `falaw`

Generate and manage AI media (images, video, audio) via fal.ai. Use this skill whenever the user wants to generate, edit, upscale, or compose media, or asks about fal.ai or fal-client. Also use it for *directorial* workflows: the user defines a Scene as data (characters, beats, shots) and falaw renders it with caching, so a single edit re-renders only what changed.

```bash
gh skill install thorwhalen/falaw falaw --agent claude-code
```

Source: [`falaw/data/skills/falaw`](https://github.com/thorwhalen/falaw/tree/HEAD/falaw/data/skills/falaw) (bundled with the pip package).

### `falaw`

Generate and manage AI media (images, video, audio) via fal.ai. Use this skill whenever the user wants to generate, edit, upscale, or compose media, or asks about fal.ai or fal-client. Also use it for *directorial* workflows: the user defines a Scene as data (characters, beats, shots) and falaw renders it with caching, so a single edit re-renders only what changed.

Source: [`.claude/skills/falaw`](https://github.com/thorwhalen/falaw/tree/HEAD/.claude/skills/falaw).

The bundled skills are also on disk after `pip install falaw`, under the package’s `data/skills/` directory; link them into an agent without network access with `skill link-skills <that directory>`.

## Instruction files

Files agents read before working in this repository.

- [`.claude/CLAUDE.md`](https://github.com/thorwhalen/falaw/tree/HEAD/.claude/CLAUDE.md): read by Claude Code

## Machine-readable documentation

This site publishes the same documentation in forms that fit an agent’s context window:

- [`llms.txt`](https://thorwhalen.github.io/falaw/llms.txt): an index of every page with a one-line description ([llms.txt](https://llmstxt.org) format)
- [`falaw.md`](https://thorwhalen.github.io/falaw/falaw.md): the whole documentation as one Markdown file
- `<page>.html.md`: a rendered Markdown twin of every page, advertised from each page’s `<head>` with `<link rel="alternate" type="text/markdown">`
- [`objects.inv`](https://thorwhalen.github.io/falaw/objects.inv): the Sphinx inventory: a symbol-to-URL index (`sphobjinv convert plain objects.inv -`)
