Repository files navigation

🚨Breaking changes in v1.0 <

We have completely rewritten the Node.JS CLI to Go in 2022 Q1. Some of the changes:

• The installation process is easier since it doesn't have any prerequisites (such as NPM). You can just simply download the executable and run it.
• The name of the executable isstream-cli instead ofstream to avoid conflicts with an existing tool (imagemagick). But you can rename it if you want to.
• The command invocation isstream-cli chat [verb-noun] [args] [options] instead ofstream [verb:noun] [args] [options]. The most obvious change is using dash instead of colon. We also added thechat keyword to preserve domain for our other productFeeds.
• The 1.0.0 Go version's feature set is matching the old one. But if you miss anything, feel free to open an issue.

Stream's Command Line Interface (CLI) makes it easy to create and manage yourStream apps directly from the terminal. Currently, only Chat is supported; however, the ability to manage Feeds will be coming soon.

The full documentation is deployed toGitHub Pages.

If you're experiencing problems directly related to the CLI, please add anissue on GitHub.

For other issues, submit asupport ticket.

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 foundhere.

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

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

$ /bin/bash -c"$(curl -fsSL https://raw.githubusercontent.com/GetStream/stream-cli/master/install/install.sh)"

$Invoke-WebRequest-Uri"https://raw.githubusercontent.com/GetStream/stream-cli/master/install/install.ps1"-OutFile"install.ps1";powershell.exe-ExecutionPolicy Bypass-File ./install.ps1

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

$ brew tap GetStream/stream-cli https://github.com/GetStream/stream-cli$ brew install stream-cli

$ git clone git@github.com:GetStream/stream-cli.git$cd stream-cli$ go build ./cmd/stream-cli$ ./stream-cli --versionstream-cli version 1.0.0

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

Note: Your API key and secret can be found on theStream Dashboard and is specific to your organization.

We purposefully chose the executable namestream-cli to avoid conflict with another tool calledimagemagick whichalready has astream executable.

If you do not haveimagemagick installed, it might be more comfortable to renamestream-cli tostream. Alternatively you can set up a symbolic link:

$ ln -s~/Downloads/stream-cli /usr/local/bin/stream$ stream --versionstream-cli version 1.0.0

Basic commands use the following syntax:

$ stream-cli [chat|feeds] [command] [args] [options]

Example:

$ stream-cli chat get-channel -t messaging -i redteam

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

$ stream-cli --help$ stream-cli chat --help$ stream-cli chat get-channel --help

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

$ stream-cli completion --help

If you have any suggestions or just want to let us know what you think of the Stream CLI, please send us a message atsupport@getstream.io or create aGitHub Issue.

We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are very happy to merge your code in the official repository. Make sure to sign ourContributor License Agreement (CLA) first. See ourlicense file for more details.

We've recently closed a$38 million Series B funding round and we keep actively growing.Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.

Check out our current openings and apply viaStream's website.