> ## Documentation Index
> Fetch the complete documentation index at: https://docs.entire.io/llms.txt
> Use this file to discover all available pages before exploring further.

# agent-help

> Show agent-facing usage that matches the installed Entire CLI.

Show coding agents which Entire command to use and retrieve exact usage for the installed CLI.

Unlike static command documentation, `agent-help` generates its output from the installed Entire binary. This helps agents avoid guessing commands or flags that may differ between CLI versions.

```bash theme={null}
entire agent-help [COMMAND...] [flags]
```

With no command, `agent-help` prints a high-level map of available commands and when to use them:

```bash theme={null}
entire agent-help
```

The output also identifies the repository detected from the Git remote. You do not need to provide the repository name when working in the current repository.

## Get help for a command

Pass a command or nested command path to see its description, subcommands, and currently installed flags:

```bash theme={null}
entire agent-help status
entire agent-help checkpoint explain
entire agent-help session resume
```

The command map only includes commands available in the current installation and repository. Commands that are deprecated, internal, or unavailable for the repository are omitted.

## Get structured output

Use `--json` when an agent or script needs structured output:

```bash theme={null}
entire agent-help --json
entire agent-help checkpoint explain --json
```

The JSON response includes the command name, short and long descriptions, detected repository, subcommands, and flags when applicable.

## Flags

| Flag           | Description                          |
| -------------- | ------------------------------------ |
| `--json`       | Emit structured JSON instead of text |
| `--help`, `-h` | Show help for `agent-help`           |

<Note>
  `entire agent-help` describes the CLI installed on your machine. Use this command as the source of truth when its output differs from static documentation.
</Note>