Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yankeexe/slack-status-cli

Lightning fast Slack status updates! :zap:
https://github.com/yankeexe/slack-status-cli

awesome awesome-go cli cobra-cli command-line go go-cli golang slack terminal terminal-app

Last synced: about 1 month ago
JSON representation

Lightning fast Slack status updates! :zap:

Awesome Lists containing this project

README

        

# Slack Status CLI
Lightning fast Slack status updates!⚡

See it in action :fire:

## Setting things up :hammer:
- [Create a new Slack app](https://api.slack.com/apps)
- Select from an **app manifest**
- Select your workspace
- Paste the following YAML app manifest:

```yaml
display_information:
name: slack-status-cli
description: Lightning fast Slack status updates!
oauth_config:
scopes:
user:
- dnd:write
- emoji:read
- users.profile:read
- users.profile:write
- users:read
- users:write
```

- Create :rocket:
- Install to workspace
- Go to OAuth and permissions
- Copy User Auth Token

### Download :inbox_tray:

> Get the latest version from [**Releases**](https://github.com/yankeexe/slack-status-cli/releases)

Make it executable

```sh
chmod +x st_
```

Move to your `$PATH`

```sh
mv st_ <$PATH>/st
```

---
### Create new profile :bear:

```bash
st profile --create # shorthand -c
```

Add your profile name and OAuth token:
image

## Usage :rainbow:

### Add new status :headphones:

Add your status, duration and emoji

```bash
st add
```

### Select status :eyes:

```bash
st set
```

### Set yourself away :sleeping:

```bash
st away
```

**Enable Do Not Disturb (DND) while away** :mask:

```bash
st away --dnd

### Set yourself active :surfer:

Remove any status, or DND settings

```bash
st active
```

### Profile management :wrench:

**Set default profile**
If you have multiple slack profiles, select default profile using:

```bash
st profile --default # shorthand -d
```

**Manage profile: change name, token, delete or update status**

Uses default profile:

```bash
st profile --manage # shorthand -m
```

Select profile to manage:

```bash
st profile --manage --select # shorthand -m -s
```

**Show current/default profile**

```bash
st profile --show
```

### Setting time duration :alarm_clock:

Valid durations for time includes:
> minutes, hours or days.
DEFAULTS to minutes

**NOTE: use single or double quotes around the time duration values.**

OPTIONS for the duration:

- minute: m, min, mins :: Example: "10 m", "10 mins", 10minute, "10 minutes"

- hour: h, hr, hour, hours :: Example: "1 h", 1hr, "1 hour", "1 hours"

- day: d, day, days :: Example: 2d, "2 day", 2days