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

# CLI reference

> Every InFlow CLI command, the global options, and the environment variables.

The CLI describes itself. Run these commands for the exact options of your installed version.

```bash theme={null}
inflow --llms              # command index
inflow --llms-full         # full manifest with every parameter
inflow <command> --schema  # JSON Schema for one command
```

The web copies are at [inflowcli.ai/llms.txt](https://inflowcli.ai/llms.txt) and [inflowcli.ai/llms-full.txt](https://inflowcli.ai/llms-full.txt).

The manifest lists flags in camel case, for example `--maxAttempts`. This site and the CLI documentation use kebab case, for example `--max-attempts`.

## Global options

| Option | Variable | What it does |
| - | - | - |
| `--api-key <key>` | `INFLOW_API_KEY` | Uses an API key instead of the saved OAuth token. |
| `--environment <production\|sandbox>` | `INFLOW_ENVIRONMENT` | Selects the environment. The default is `production`. |
| `--sandbox` | | The short form of `--environment sandbox`. |
| `--format <json\|toon\|yaml\|md\|jsonl>` | | Sets the output format for agents. The default is an interactive view in a terminal, and `toon` in other cases. |
| `--skill [name]` | | Prints a bundled skill and exits. The default skill is `agentic-payments`. |
| `--bootstrap` | | Prints the agent setup guide and exits. The same text is at `inflowcli.ai/skill.md`. |
| `--verbose` | | Logs each HTTP request and response to stderr. |
| `--base-url <url>` | `INFLOW_BASE_URL` | Replaces the API URL of the environment. It takes precedence over `--environment`. |
| `--auth-base-url <url>` | `INFLOW_AUTH_BASE_URL` | Replaces the OAuth endpoint. |
| `--auth <path>` | `INFLOW_AUTH_FILE` | Names a legacy plaintext credentials file for deletion. It is not a credential store. |
| `--mcp` | | Runs the CLI as an MCP server. |

## Environment variables

| Variable | What it does |
| - | - |
| `INFLOW_API_KEY` | Sets the API key. |
| `INFLOW_ENVIRONMENT` | Sets `production` or `sandbox`. |
| `INFLOW_BASE_URL` | Replaces the API URL. |
| `INFLOW_AUTH_BASE_URL` | Replaces the OAuth endpoint. |
| `INFLOW_AUTH_FILE` | Names a legacy credentials file for deletion. |
| `INFLOW_HTTP_PROXY` | Sends every outbound request through this proxy URL. |
| `NO_UPDATE_NOTIFIER` | Set it to `1` to stop the version checks. |

The CLI reads each setting in this order: the flag, the environment variable, the saved configuration, and the built-in default.

## Authentication

| Command | What it does |
| - | - |
| `inflow auth login` | Logs in with the OAuth device flow. |
| `inflow auth status` | Shows the authentication status. `--probe` tests the token against the server. |
| `inflow auth logout` | Logs out. It also deletes the local vault and the stored service credentials. |

See [Authenticate](/agents/authenticate).

## Vault

| Command | What it does |
| - | - |
| `inflow vault unlock` | Unlocks or initializes the local vault. |
| `inflow vault lock` | Locks the vault. |
| `inflow vault status` | Shows the vault status. |
| `inflow vault policy` | Shows the lock policy. |
| `inflow vault set-policy` | Changes the lock policy. |
| `inflow vault change-passphrase` | Changes the PIN or the passphrase. |
| `inflow vault reset` | Removes the vault database, sidecar, and runtime files. It needs `--force`. |

See [Install the CLI](/agents/install-the-cli#unlock-the-vault).

## Account

| Command | What it does |
| - | - |
| `inflow balances list` | Lists your balances. |
| `inflow deposit-addresses list` | Lists your deposit addresses. |

## Inspection

| Command | What it does |
| - | - |
| `inflow inspect <url>` | Reports the discovery, enrollment, and payment capabilities of a URL. The URL can be an origin, an ODP or OpenAPI document URL, or an endpoint. It does not enroll or pay. `--refresh` validates the public documents again. |

## Directory

| Command | What it does |
| - | - |
| `inflow directory search [query]` | Searches the directory for services and collections. It needs a query or a filter. |
| `inflow directory suggest <prefix>` | Finds matching service and collection names. |

See [The InFlow directory](/concepts/directory) for the filters.

## Discovery (ODP)

| Command | What it does |
| - | - |
| `inflow odp inspect <service>` | Shows the capabilities of a service. |
| `inflow odp collections list <service>` | Lists the collections of a service. |
| `inflow odp collections search <service> [query]` | Searches the collections of a service. |
| `inflow odp collections get <service> <id>` | Shows the details of one collection. |
| `inflow odp offerings list <service>` | Lists the offerings of a service. |
| `inflow odp offerings search <service> [query]` | Searches the offerings of a service. |
| `inflow odp offerings get <service> <id>` | Shows the details of one offering. |
| `inflow odp offerings capabilities <service>` | Shows the search filters and sorts of a service. |
| `inflow odp offerings discover [query]` | Finds offerings across services from the directory. |
| `inflow odp actions resolve <service> <offeringId> <actionId>` | Turns an action into an executable request. It does not invoke it. |

See [Discover and enroll](/agents/discover-and-enroll).

## OpenAPI services

| Command | What it does |
| - | - |
| `inflow openapi operations list <source>` | Lists the OpenAPI operations. It can filter by directory collection or by provider tag. |
| `inflow openapi operations get <source>` | Shows one operation. It does not call it or get credentials. |
| `inflow openapi operations prepare <source>` | Builds a request preview. It does not call the operation, enroll, or pay. |
| `inflow openapi operations call <source>` | Calls an operation one time. For a paid operation, it gives you the payment command to use. Get approval first. |

See [Discover and enroll](/agents/discover-and-enroll#use-an-openapi-service).

## Enrollment (AEP)

| Command | What it does |
| - | - |
| `inflow aep inspect <serviceReference>` | Reads an AEP service without authentication. |
| `inflow aep enroll <serviceReference>` | Enrolls with an AEP service. |
| `inflow aep fetch <resourceUrl>` | Fetches a resource. It authenticates with AEP when the service challenges it. |
| `inflow aep grant <serviceReference>` | Requests a service credential and stores it. |
| `inflow aep revoke <serviceReference>` | Revokes service credentials. |
| `inflow aep status <serviceReference>` | Shows the AEP lifecycle status. |

## Payments (MPP)

| Command | What it does |
| - | - |
| `inflow mpp inspect <url>` | Shows the MPP challenges of a URL. It sends a request but does not pay. |
| `inflow mpp supported` | Lists your payment methods by intent, rail, and currency. |
| `inflow mpp pay <url>` | Pays an MPP resource and returns the seller response. |
| `inflow mpp fetch <transactionId> <resourceUrl>` | Completes a ready or pending payment and fetches the resource. |
| `inflow mpp status <transactionId>` | Shows the buyer state of a transaction. |
| `inflow mpp cancel <approvalId>` | Tries to cancel an approval. |
| `inflow mpp subscribe <url>` | Subscribes to a resource. The owner approves the recurring terms, and the first period settles. |
| `inflow mpp decode <value>` | Decodes a `WWW-Authenticate: Payment` header, a credential, or a receipt. |

## Payments (x402)

| Command | What it does |
| - | - |
| `inflow x402 inspect <url>` | Shows the `PAYMENT-REQUIRED` options of a URL. It sends a request but does not pay. |
| `inflow x402 supported` | Lists your buyer capabilities by scheme and network. |
| `inflow x402 pay <url>` | Pays an x402 resource and returns the seller response. |
| `inflow x402 fetch <transactionId> <resourceUrl>` | Fetches the resource for a signed or pending payment. |
| `inflow x402 status <transactionId>` | Shows the signing state of a transaction. |
| `inflow x402 cancel <approvalId>` | Tries to cancel an approval. |
| `inflow x402 decode <header>` | Decodes a `PAYMENT-REQUIRED` header. |

See [Pay for a resource](/agents/pay-for-a-resource).

## Subscriptions

| Command | What it does |
| - | - |
| `inflow subscriptions list` | Lists your subscriptions. |
| `inflow subscriptions get <subscriptionId>` | Shows one subscription. |
| `inflow subscriptions fetch <subscriptionId> <resourceUrl>` | Fetches a resource with an active subscription. |
| `inflow subscriptions cancel <subscriptionId>` | Cancels a subscription at once. |

## Polling flags

Commands that wait for an approval share these flags.

| Flag | Default | What it does |
| - | - | - |
| `--interval` | `0` | Poll cadence in seconds. `0` returns at once with a follow-up command. For `aep enroll` and `aep grant`, the value has no default and must be more than `0`. |
| `--max-attempts` | `0` | The maximum number of polls. `0` sets no limit. |
| `--timeout` | `900` | The deadline in seconds. For `auth login` and `auth status`, the default is `300`. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.