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

# Install the Straddle CLI

> Install the CLI on macOS, Linux, or Windows and verify the command is available.

Install `straddle` with a package manager or a release archive. Release binaries support x64 and ARM64 on macOS, Linux, and Windows.

<Steps>
  <Step title="Choose an installation method">
    <Tabs>
      <Tab title="Homebrew">
        On macOS, install from the Straddle tap:

        ```bash theme={null}
        brew install straddle-build/tap/straddle
        ```
      </Tab>

      <Tab title="npm">
        With Node.js 18 or later, install the CLI globally:

        ```bash theme={null}
        npm install -g @straddlecom/cli
        ```

        To try it without a global installation, run `npx @straddlecom/cli --help`. Keep npm's optional dependencies enabled; they provide the binary for your platform.
      </Tab>

      <Tab title="Shell installer">
        On macOS or Linux, use the shell installer:

        ```bash theme={null}
        curl -fsSL https://raw.githubusercontent.com/straddle-build/straddle-cli/main/install.sh | sh
        ```

        The installer downloads a release, verifies its SHA-256 checksum, and installs to `~/.local/bin`. Set `STRADDLE_INSTALL_DIR` for the installer process to choose another directory.
      </Tab>

      <Tab title="Release archive">
        Download the archive for your operating system and architecture from [Straddle CLI releases](https://github.com/straddle-build/straddle-cli/releases). Compare its SHA-256 checksum with the release's `checksums.txt`, then extract the binary into a directory on `PATH`.

        macOS release binaries are signed and notarized. Gatekeeper needs a network connection to check notarization on the first launch of a quarantined download.
      </Tab>
    </Tabs>
  </Step>

  <Step title="Verify the command">
    Check the version and available commands:

    ```bash theme={null}
    straddle version
    straddle --help
    ```

    A version number and command list confirm that your shell can run the CLI. If the command isn't found, add the installation directory to `PATH` and open a new terminal.
  </Step>

  <Step title="Connect your Straddle account">
    [Configure credentials and context](/developer-tools/cli/auth-context), then make a read request to confirm the API key works in the selected environment.
  </Step>
</Steps>

<Accordion title="Install with Go">
  With a Go toolchain that meets the release's [module requirements](https://github.com/straddle-build/straddle-cli/blob/v1.0.4/go.mod), install from source:

  ```bash theme={null}
  go install github.com/straddle-build/straddle-cli/cmd/straddle@latest
  ```

  Add your Go binary installation directory to `PATH`, then run `straddle version`.
</Accordion>


## Related topics

- [Compare charge and payout volume](/playbooks/account-cash-flow.md)
- [Reconcile payments](/playbooks/reconcile-payments.md)
- [Check payment progress](/playbooks/payment-progress.md)
- [Investigate failed and returned payments](/playbooks/returns.md)
- [Investigate payment data](/playbooks/investigate-data.md)


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