---
title: flue docs
description: Reference for listing, reading, and searching the bundled Flue documentation.
lastReviewedAt: 2026-06-09
---

## Synopsis

```bash
flue docs
flue docs read <path>
flue docs search <query>
```

## Description

`flue docs` works with the documentation bundled inside the installed `@flue/cli` package. It requires no network access, and its content always matches the installed CLI version.

With no arguments, the command prints usage hints and the full page catalog. `read` prints one page as Markdown. `search` prints ranked results as JSON.

The catalog, page Markdown, and search JSON print to stdout; usage hints and errors print to stderr.

## Subcommands

| Subcommand       | Description                                         |
| ---------------- | --------------------------------------------------- |
| _(none)_         | List every documentation page with path and title.  |
| `read <path>`    | Print one documentation page as Markdown.           |
| `search <query>` | Search the documentation and print results as JSON. |

## Page paths

`read` accepts the catalog path as printed by `flue docs`, plus equivalent website forms:

```bash
flue docs read guide/sandboxes
flue docs read /docs/guide/sandboxes/
flue docs read https://flueframework.com/docs/guide/sandboxes/
```

Unknown pages exit with status `1`.

## Search output

`search` joins multiple arguments into one query and prints the top eight matches:

```json
{
  "query": "durable execution",
  "results": [
    {
      "path": "concepts/durable-execution",
      "title": "Durable Agents",
      "description": "Understand how Flue agents and workflows handle server restarts, interrupted connections, and other disruptions.",
      "excerpt": "Durable execution is about recovering safely when running work is disrupted by a server restart, deployment, lost connec…",
      "score": 138.34
    }
  ]
}
```

## Examples

```bash
flue docs
flue docs read guide/sandboxes
flue docs search "durable execution"
flue docs search sandbox adapter
```

For coding agents, the typical loop is `flue docs search <query>` to find a page, then `flue docs read <path>` to read it.