shout-run
v0.2.0
Published
CLI for shout.run - live terminal broadcasting
Maintainers
Readme
shout.run CLI
Live terminal broadcasting for developers. Share your terminal with anyone who has a browser.
Install
npm install -g shout-runQuick start
shout login # authenticate with GitHub
shout # start broadcasting (interactive)Your session goes live instantly at https://shout.run/<username>/<session-id>.
Commands
| Command | Description |
|---------|-------------|
| shout | Start broadcasting (default command) |
| shout login | Authenticate with GitHub |
| shout logout | Remove stored credentials |
| shout whoami | Display current logged-in user |
| shout api-key create <name> | Create a new API key |
| shout api-key list | List your API keys |
| shout api-key revoke <id> | Revoke an API key |
Broadcast options
shout --title "Building a CLI" # set session title
shout --visibility private # public (default) or private
shout --tags "rust,cli,demo" # comma-separated tagsPipe mode
cargo test 2>&1 | shout --title "Test run"API keys
Create API keys for use with the SDK and MCP packages:
shout api-key create "My Agent" # create a key (shown only once)
shout api-key list # list your keys
shout api-key revoke <id> # revoke a keyHow it works
The CLI captures your terminal output via a PTY, streams it over WebSocket to the shout.run relay, and viewers watch in real-time through a web terminal.
Requirements
- Node.js >= 20
- macOS, Linux, or Windows
Links
- Website: shout.run
- GitHub: github.com/pavanmadiraju91/shout-run
License
MIT
