# Seam CLI

<figure><img src="https://2727122207-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxnN2A67918om1UthYWsF%2Fuploads%2Fgit-blob-b9fb3f9a0424f73fb105adc2027ee6a813223562%2Fseam-cli-cover.png?alt=media" alt="The Seam CLI is a great way to to explore and test the Seam API."><figcaption><p>The Seam CLI is a great way to to explore and test the Seam API.</p></figcaption></figure>

The Seam Command Line Interface (CLI) is a fully interactive CLI version of the Seam API. You can [install the Seam CLI locally](#install-the-seam-cli) or use the [Seam Online CLI](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli) within the [Seam Console](https://docs.seam.co/latest/core-concepts/seam-console). Quick, intuitive, and easy to use, the Seam CLI enables you to perform a variety of useful tasks, including the following:

* Explore and test all the available methods in the Seam API interactively.
* View resources or test API functions easily and quickly.
* Inspect the results of your API commands.
* Access Seam API functionality that is not currently available in the Seam Console.

<figure><img src="https://2727122207-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxnN2A67918om1UthYWsF%2Fuploads%2Fgit-blob-3c7700f32547e5b3e1bc9504fb70ec438cb22369%2Fseam-cli-demo.gif?alt=media" alt="Use the interactive Seam Online CLI to explore and test the Seam API." width="563"><figcaption><p>Use the interactive Seam CLI to explore and test the Seam API.</p></figcaption></figure>

## Installing the Seam CLI

Install the Seam CLI using [`npm`](https://www.npmjs.com/package/seam-cli) or [Homebrew](https://formulae.brew.sh/formula/seam).

### Install Using `npm`

Enter the following command:

```bash
npm install -g seam-cli
```

### Install Using Homebrew

Enter the following commands:

```bash
brew tap seamapi/homebrew-seam
brew install seam
```

## Using the Seam CLI

Interact with the Seam CLI using any combination of interactive and typed commands. You "construct" the full command, including any desired parameters, and then run the command.

For details, see [Use the Seam CLI](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli#use-the-seam-cli) and [Seam CLI Command Stubs](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli#seam-cli-command-stubs).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.seam.co/latest/developer-tools/seam-cli.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.