CLI

The Channel3 CLI calls the Channel3 API from a terminal or script.

Install the CLI

npm install -g @channel3/cli

To update an existing installation:

npm update -g @channel3/cli

Upgrading from 0.4.x? Versions up to 0.4.1 were installed with Homebrew. Remove that build first — it is no longer updated:

brew uninstall --cask channel3
npm install -g @channel3/cli

The binary name and CHANNEL3_API_KEY are unchanged, but some flags are not. Most importantly, --query is now --query-param for search terms. See Migrating to 0.5.0.

Set an API key

export CHANNEL3_API_KEY="your_api_key_here"

Set optional locale defaults:

export CHANNEL3_LANGUAGE="en"
export CHANNEL3_COUNTRY="US"
export CHANNEL3_CURRENCY="USD"

Add the export lines to ~/.zshrc (or ~/.bashrc), then source ~/.zshrc.

You can also pass --api-key to an individual command.

Run a search

channel3 products search --query-param "organic cotton t-shirt"

Explore the CLI

The full CLI reference keeps every command in one place.

Getting Started

Make a Search

Get Product Data

Conversational Agent

Checkout

Pricing, Reporting, and Commissions

Build

Integrate

FAQ

Explore the CLI

​Explore the CLI

Explore the CLI