Stream CLI Quickstart

LAST EDIT Feb 06 2023

Stream's command line interface (CLI) makes it easy to create and manage your Stream Chat applications directly from the command line. The source code and full documentation can be found on GitHub.Installation

The Stream CLI is written in Go and precompiled into a single binary. It doesn’t have any prerequisites.

Installation

Copied!

Download the binaries

Copied!

You can find the binaries in the Release section of the repository. We also wrote a short script to download them and put it to your PATH.

Bash (MacOS and Linux)

Copied!

PowerShell (Windows) 

Copied!

Homebrew

Copied!

For MacOS users, it’s also available via Homebrew:

Compile yourself

Copied!

Getting Started

Copied!

In order to initialize the CLI, it’s as simple as:

Note: Your API key and secret can be found on the Stream Dashboard and is specific to your application.

Use Cases and example

Copied!

A couple of example use cases can be found here. We’ve also created a separate documentation for the import feature.

🚨Warning

Copied!

We purposefully chose the executable name stream-cli to avoid conflict with another tool called imagemagick which already has a stream executable.

If you do not have imagemagick installed, it might be more comfortable to rename stream-cli to stream. Alternatively you can set up a symbolic link:

Syntax

Copied!

Basic commands use the following syntax:

Example:

The --help keyword is available every step of the way. Examples:

Auto completion

Copied!

We provide autocompletion for the most popular shells (PowerShell, Bash, ZSH, Fish).

Issues

Copied!

If you’re experiencing problems directly related to the CLI, please add an issue on GitHub.

For other issues, submit a support ticket.

Changelog

Copied!

As with any project, things are always changing. If you’re interested in seeing what’s changed in the Stream CLI, the changelog for this project can be tracked in the Release page of the repository.