Skip to main content
The JoyStream CLI ships as a single self-contained binary. Everything in these docs uses jstm.
jstm and joystream are the same program under two names. The prebuilt binary is called joystream; jstm is the short alias. Use whichever you prefer — the docs use jstm.

​
Download the binary

Releases publish a macOS arm64 binary. Download it from the matching cli-v* release tag:
On first run, macOS may quarantine the binary. Clear the quarantine attribute with xattr -cr ./joystream, then run it again.
Move it onto your PATH to use it from anywhere:
CI currently builds macos-arm64 only. On other platforms, build from source.

​
Build from source

Requires uv.
make build names the binary for your platform automatically. A prebuilt binary won’t pick up source edits until you rebuild, so during development run from source or re-run make install.

​
Set up and sign in

jstm login with no flags opens your browser and shows a verification code, the same way gh and similar tools work. If you’re on a machine without a browser, add --no-browser and it prints the URL and code instead. To sign in entirely in the terminal with an emailed one-time code:
See Authentication for every sign-in mode.

​
Shell completion

​
Verify

​
Next

Quickstart

Draft, build, and dry-run your first agent.

Configuration

Config paths, environment variables, and precedence.