Seam CLI

Use the interactive Seam CLI as a user-friendly and efficient way to explore and test the Seam API.

The Seam Command Line Interface (CLI) is a fully interactive CLI version of the Seam API. You can install the Seam CLI locally or use the Seam Online CLI within the 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.

Installing the Seam CLI

Install the Seam CLI using npm or Homebrew.

Install Using npm

Enter the following command:

npm install -g seam-cli

Install Using Homebrew

Enter the following commands:

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 and Seam CLI Command Stubs.

Last updated

Logo

© Seam Labs, Inc. All rights reserved.