A cli for interacting with slack from a terminal.
- OSX only (possible to support linux in the future)
- Slack desktop app installed
- Credentials are borrowed from the slack app after it has authenticated
The cli can be installed by downloading the appropriate binary from the releases tab or by using any of the supported installation methods.
go install github.com/graytonio/slack-cli@latestNOTE: Brew install will be availabel in the future
On first run the cli will create a configuration file at ~/.config/slackcli.yaml with a blank configuration file. It will then output an error that the credentials are not configured. Open the configuration file and fill in the workspace key with the name of the workspace you want the cli to connect to.
For example if your slack workspace is my-workspace.slack.com then you would fill in the configuration file to look like:
workspace: "my-workspace"NOTE Before running the cli again make sure to fully quit the slack desktop application before running the cli again. The credentials are extracted from the local storage of the slack app and stored in the configuration file for future use. Once this has happened the app can be open without interfering with the functionality of the cli.
Sending a message to a user or to a channel by using the id of the conversation or a saved alias.
Example
# Basic Usage
slack-cli send C12341234 "Hello this is my message"
# Use stdin as message
echo "Hello from my terminal" | slack-cli send C12341234 -
# Use user alias
slack-cli send @username "Hello username"
# Use channel alias
slack-cli send "#my-channel-name" "Hello team"Since the slack api does not support looking up a user or channel by it's name the cli supports saving a user or channel id as an alias for later use. These aliases can later be used in other commands like the send command
Example
# Save User
slack-cli save user my-user U12341234
# Save Channel
slack-cli save channel my-team-chat C12341234