> ## 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.

# Install the CLI

> Install the InFlow CLI on macOS, Linux, or Windows. Then unlock the local vault.

The InFlow CLI is a signed native application. It gives an agent discovery with ODP, enrollment with AEP, and payments with MPP and x402.

## Supported platforms

| Platform | Architectures |
| - | - |
| macOS | Apple Silicon and Intel |
| Windows | x64 and ARM64 |
| Linux | ARM64 and AMD64 |

The Linux installer supports Debian, Ubuntu, Fedora, and RHEL with systemd. It needs `gpgv`, and root or `sudo` access.

## Install the CLI

<CodeGroup>
  ```bash macOS / Linux theme={null}
  curl -fsSL https://inflowcli.ai/install.sh | bash
  ```

  ```powershell Windows theme={null}
  irm https://inflowcli.ai/install.ps1 | iex
  ```
</CodeGroup>

On Windows, run PowerShell as a user who can approve the Windows Installer admin prompt.

Check the installed version.

```bash theme={null}
inflow --version
```

Do not install the CLI from npm. The `@inflowpayai/inflow` npm package is only a compatibility notice. It does not run commands, start MCP, or manage credentials.

<Accordion title="Other ways to install">
  **Homebrew (macOS)**

  ```bash theme={null}
  brew tap inflowpayai/tap
  brew install --cask inflow
  ```

  **WinGet (Windows)**

  ```powershell theme={null}
  winget install --id InFlowPayAI.InFlow --exact
  ```

  **Compatibility endpoint.** It selects the correct installer on macOS, on Linux, and in Git Bash on Windows.

  ```bash theme={null}
  curl -fsSL https://inflowcli.ai/cli | bash
  ```

  **Direct download.** Each [GitHub Release](https://github.com/inflowpayai/inflow-cli/releases) has one file for each platform.

  | File | Platform |
  | - | - |
  | `inflow-<version>-darwin-arm64.zip` | Apple Silicon Macs |
  | `inflow-<version>-darwin-x64.zip` | Intel Macs |
  | `inflow-<version>-windows-arm64.msi` | Windows ARM64 |
  | `inflow-<version>-windows-x64.msi` | Windows x64 |

  Linux releases include Debian packages, RPM packages, and standalone archives for ARM64 and AMD64. The macOS zip file contains `InFlow.app`, with the executable at `InFlow.app/Contents/MacOS/inflow`.
</Accordion>

### What the installer does

The installer checks each package before it installs it.

| Platform | Checks | Result |
| - | - | - |
| macOS | Checksum, code signature, and Gatekeeper | `InFlow.app` goes into `~/.local/share/inflow`. The `inflow` command goes into `~/.local/bin`. |
| Linux | OpenPGP-signed release manifest and package checksum | The matching Debian or RPM system package. This package installs the system vault service. |
| Windows | MSI checksum, Authenticode status, and publisher | Windows Installer installs the CLI and its vault service. |

## Upgrade the CLI

Run the installer again. It installs the latest GitHub Release.

<CodeGroup>
  ```bash macOS / Linux theme={null}
  curl -fsSL https://inflowcli.ai/install.sh | bash
  ```

  ```powershell Windows theme={null}
  irm https://inflowcli.ai/install.ps1 | iex
  ```

  ```bash Homebrew theme={null}
  brew upgrade --cask inflow
  ```

  ```powershell WinGet theme={null}
  winget upgrade --id InFlowPayAI.InFlow --exact
  ```
</CodeGroup>

When a newer version is available, the `inflow auth status` response contains an `update` field.

## Unlock the vault

The CLI keeps OAuth tokens, API keys, and service credentials in an encrypted local vault. Initialize the vault before the first command that uses a credential.

```bash theme={null}
inflow vault unlock
```

The command asks for a PIN or a passphrase. The CLI reads it only from the terminal, never from an MCP argument, a flag, an environment variable, or agent input.

<Warning>
  Run `inflow vault unlock` yourself, in your own terminal. Never give the PIN or the passphrase to an agent.
</Warning>

When the vault is locked, a command from an agent returns a human-action error. Only the owner can unlock the vault.

### Manage the vault

| Command | What it does |
| - | - |
| `inflow vault status` | Shows the local vault status. |
| `inflow vault lock` | Locks the vault. |
| `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 --force` | Deletes the local vault database, sidecar, and runtime files. |

`status`, `lock`, and `policy` do not need the PIN or the passphrase.

`set-policy` accepts two flags. `--idle-timeout-seconds` locks the vault after that many idle seconds. `0` disables the idle timeout. `--lock-on-sleep` locks the vault when the computer sleeps.

<Warning>
  `inflow vault reset --force` deletes every credential in the vault. After a reset, log in again. Then run `inflow aep status` for each service. If a service shows no enrollment, enroll again.
</Warning>

## Stop update checks

Set `NO_UPDATE_NOTIFIER=1` to stop the version checks.

```bash theme={null}
export NO_UPDATE_NOTIFIER=1
```

## Uninstall the CLI

<CodeGroup>
  ```bash macOS / Linux theme={null}
  curl -fsSL https://inflowcli.ai/install.sh | bash -s -- --uninstall
  ```

  ```powershell Windows theme={null}
  $env:INFLOW_UNINSTALL = '1'
  try { irm https://inflowcli.ai/install.ps1 | iex } finally { Remove-Item Env:INFLOW_UNINSTALL }
  ```

  ```bash Homebrew theme={null}
  brew uninstall --cask inflow
  ```

  ```powershell WinGet theme={null}
  winget uninstall --id InFlowPayAI.InFlow --exact
  ```
</CodeGroup>

The Windows installer keeps the encrypted vault data when it uninstalls the CLI.

## Next step

<Card title="Authenticate" icon="key" href="/agents/authenticate">
  Log the agent in with the device flow or with an API key.
</Card>


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