https://github.com/jordangarrison/whats-my-status
Multi-platform presence sharing
https://github.com/jordangarrison/whats-my-status
fyne fyneapp github go golang presence presence-management slack status
Last synced: about 2 months ago
JSON representation
Multi-platform presence sharing
- Host: GitHub
- URL: https://github.com/jordangarrison/whats-my-status
- Owner: jordangarrison
- License: apache-2.0
- Created: 2021-11-07T19:25:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-17T20:17:15.000Z (over 2 years ago)
- Last Synced: 2024-06-20T22:35:50.487Z (10 months ago)
- Topics: fyne, fyneapp, github, go, golang, presence, presence-management, slack, status
- Language: Go
- Homepage:
- Size: 147 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# What's My Status?
What's my status? is a command line utility that allows you to set your status on multiple platforms at once.
## Installation
### GUI
To install the GUI, download the binary for your platform from the [latest release](https://github.com/jordangarrison/whats-my-status/releases).
#### MacOS
Simply unzip the file and drag it into your Applications folder.
#### Windows
Simply unzip the file and drag it into your Start Menu.
#### Linux
To install run the following after downloading the tarball:
```bash
tar -Jvf whats-my-status-linux-*.xz
cd whats-my-status-linux-*
sudo make install
```
To uninstall run the following:
```bash
sudo make uninstall
```
### CLI
To install the cli, download the binary for your platform from the [latest release](https://github.com/jordangarrison/whats-my-status/releases) and place it in your `$PATH`.
You can install from the go command:
```sh
go install github.com/jordangarrison/whats-my-status/wms@latest
```
## Setup
Copy the `.wms.example.yaml` file to `~/.wms.yaml` and edit it to your liking.
The general stucture of the file is as follows:
```yaml
# workspaces are the places you want to set your status
workspaces:
- name:
type: slack
token:
- name:
type: github
token:
aliases:
- name: myalias
status:
StatusMessage: "I'm doing something"
Emoji: :smile:
Time: "30m"
```
## Aliases
You can set up aliases for your status commands. For example, if you want to set your status to `"Focus time"`, you can do the following:
```yaml
aliases:
- name: focus
status:
StatusMessage: "Focus Time"
Emoji: ":compute:"
Time: "1h"
```
You can run this alias simply with the following command:
```sh
wms status focus
```
The `clear` alias is a preset alias which will clear your status on all your workspaces.
## Tokens
You will need to generate tokens for access to your workspaces.
### Slack
For now, slack uses an old style token. You can generate it following these steps from the [Emacs Slack Repo (yuya373/emacs-slack)](https://github.com/yuya373/emacs-slack#how-to-get-token):
- Navigate to your Slack workspace customization portal at `https://[your-workspace].slack.com/customize`
- Log in with your credentials for the workspace if needed
- Open the console (`Ctrl+Shift+J` on Linux/Windows, `Cmd+Opt+J` on Mac)
- Run the following command: `window.prompt('your api token is: ', TS.boot_data.api_token)`
- Copy token to your `~/.wms.yaml` file
### GitHub
For github navigate to your [profile tokens settings](https://github.com/settings/tokens) and generate a new token with the following scopes:
- `user`
## Platform Support
- [x] Slack
- [x] GitHub
- [ ] Discord
- [ ] Google Hangouts
- [ ] Microsoft Teams
- [ ] Nextcloud
- [ ] Matrix (via Riot)