slack-status-cli/README.md

72 lines
2.7 KiB
Markdown
Raw Normal View History

2021-01-05 22:23:21 +00:00
# slack-status-cli
2021-01-05 22:54:24 +00:00
Set your Slack status via the command line
2021-01-07 17:19:56 +00:00
## Requirements
Rather than host a web server that you would need to trust, this command runs one on your local machine to retrieve the OAuth code. This page is hosted with an auto generated, self-signed certificate.
This requires you to have `openssl` installed on your machine and, when the page loads for the first time, it will require you to trust the certificate or ignore the warning.
2021-02-03 01:08:09 +00:00
Here's how to do that on [Firefox](https://support.mozilla.org/en-US/kb/error-codes-secure-websites?as=u&utm_source=inproduct#w_self-signed-certificate). On Chrome, you may have to enable `chrome://flags/#allow-insecure-localhost`. If you can't get the link to open in Chrome, you can copy the URL into a different browser and try it there. It should work in Firefox or Safari.
2021-01-07 17:19:56 +00:00
2021-01-07 17:38:50 +00:00
## Setup
1. Install the command from the Releases tab
2. Run the command! On first run, you will be asked to authenticate and install the app in your workspace
2021-01-05 22:54:24 +00:00
## Example usage
Login (it will store it in `~/.config/slack-status-cli` or your `$XDG_CONFIG_HOME` dir
2021-01-05 22:54:24 +00:00
slack-status -login
slack-status -login -domain custom-workspace-name
slack-status -make-default -domain new-default-workspace
Specify domain to use
# Use the deafult domain
slack-status :face_with_cowboy_hat: Howdy partner
# Specify domain for this status
slack-status -domain my-workspace :face_with_cowboy_hat: Howdy partner
# Specify domain for this status and make it the new default
slack-status -domain my-workspace -make-default :face_with_cowboy_hat: Howdy partner
2021-01-05 22:54:24 +00:00
Set status without emoji
slack-status Walking the dog
Set status with emoji
slack-status :walking-the-dog: Walking the dog
slack-status -emoji :walking-the-dog: Walking the dog
2021-01-05 22:54:24 +00:00
Set status with duration (eg. `10m`, `2h`, `7d12h`)
slack-status 10m :walking-the-dog: Walking the dog
slack-status :walking-the-dog: Walking the dog for 10m
slack-status -duration 10m -emoji :walking-the-dog: Walking the dog
2021-01-05 22:54:24 +00:00
Set status with duration and snooze notifications
slack-status -snooze -duration 12h -emoji :bed: Good night
slack-status -snooze :bed: Good night for 12h
2021-01-05 22:54:24 +00:00
Set a status that contains a duration
# Set status to "On a break" for 5 minutes
slack-status :sleeping: On a break for 5m
# Set status to "On a break for 5m" for 5 minutes
slack-status -duration 5m :sleeping: On a break for 5m
2021-01-05 22:54:24 +00:00
# Set status to "On a break for 5m" with no duration
slack-status :sleeping: "On a break for 5m"
Clear existing status and snooze durations
slack-status
Snooze notifications without updating your status
slack-status -duration 15m -snooze