Stream CLI Quickstart
Confused about "Stream CLI Quickstart"?
Let us know how we can improve our documentation:
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!Confused about "Installation"?
Let us know how we can improve our documentation:
Download the binaries
Copied!Confused about "Download the binaries"?
Let us know how we can improve our documentation:
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!Confused about "Bash (MacOS and Linux)"?
Let us know how we can improve our documentation:
PowerShell (Windows)
Copied!Confused about "PowerShell (Windows) "?
Let us know how we can improve our documentation:
Homebrew
Copied!Confused about "Homebrew"?
Let us know how we can improve our documentation:
For MacOS users, it’s also available via Homebrew:
Compile yourself
Copied!Confused about "Compile yourself"?
Let us know how we can improve our documentation:
Getting Started
Copied!Confused about "Getting Started"?
Let us know how we can improve our documentation:
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!Confused about "Use Cases and example"?
Let us know how we can improve our documentation:
A couple of example use cases can be found here. We’ve also created a separate documentation for the import feature.
🚨Warning
Copied!Confused about "🚨Warning"?
Let us know how we can improve our documentation:
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!Confused about "Syntax"?
Let us know how we can improve our documentation:
Basic commands use the following syntax:
Example:
The --help
keyword is available every step of the way. Examples:
Auto completion
Copied!Confused about "Auto completion"?
Let us know how we can improve our documentation:
We provide autocompletion for the most popular shells (PowerShell, Bash, ZSH, Fish).
Issues
Copied!Confused about "Issues"?
Let us know how we can improve our documentation:
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!Confused about "Changelog"?
Let us know how we can improve our documentation:
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.