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

# formae agent

> Start and stop the formae agent. Reference for formae agent and its subcommands.

Manage the [formae agent](/documentation/concepts/architecture), the long-running process
that reconciles your infrastructure and answers CLI requests.

```bash theme={"languages":{"custom":["/languages/pkl.json"]}}
formae agent <start|stop|status> [flags]
```

### Examples

```bash theme={"languages":{"custom":["/languages/pkl.json"]}}
formae agent start
formae agent stop
formae agent status
```

## formae agent start

Start the agent.

```bash theme={"languages":{"custom":["/languages/pkl.json"]}}
formae agent start [flags]
```

### Flags

| Flag               | Default | Description            |
| ------------------ | ------- | ---------------------- |
| `--config <path>`  |         | Path to a config file. |
| `--profile <name>` |         | Named profile to use.  |

## formae agent stop

Stop the agent.

```bash theme={"languages":{"custom":["/languages/pkl.json"]}}
formae agent stop [flags]
```

This subcommand takes no flags beyond `--help`.

## formae agent status

Receive the agent status: whether it is reachable, its version, and the plugins
it has loaded.

```bash theme={"languages":{"custom":["/languages/pkl.json"]}}
formae agent status [flags]
```

This replaces `formae status agent`, which still works but prints a deprecation
notice.

### Examples

```bash theme={"languages":{"custom":["/languages/pkl.json"]}}
formae agent status
formae agent status --watch
```

### Flags

| Flag                                 | Default | Description                                                 |
| ------------------------------------ | ------- | ----------------------------------------------------------- |
| `--watch`                            | `false` | Continuously refresh and print the status until completion. |
| `--output-consumer <human\|machine>` | `human` | Consumer of the command result.                             |
| `--output-schema <json\|yaml>`       | `json`  | The schema to use for the machine output.                   |
| `--config <path>`                    |         | Path to a config file.                                      |
| `--profile <name>`                   |         | Named profile to use.                                       |