Code Monkey home page Code Monkey logo

whats-my-status's Introduction

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.

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:

tar -Jvf whats-my-status-linux-*.xz
cd whats-my-status-linux-*
sudo make install

To uninstall run the following:

sudo make uninstall

CLI

To install the cli, download the binary for your platform from the latest release and place it in your $PATH.

You can install from the go command:

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:

# workspaces are the places you want to set your status
workspaces:
  - name: <your-slack-org>
    type: slack
    token: <your-slack-token>
  - name: <your-github-user>
    type: github
    token: <your-github-user-scope-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:

aliases:
  - name: focus
    status:
      StatusMessage: "Focus Time"
      Emoji: ":compute:"
      Time: "1h"

You can run this alias simply with the following command:

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):

  • 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 and generate a new token with the following scopes:

  • user

Platform Support

  • Slack
  • GitHub
  • Discord
  • Google Hangouts
  • Microsoft Teams
  • Nextcloud
  • Matrix (via Riot)

whats-my-status's People

Contributors

jordangarrison avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

whats-my-status's Issues

Remove the UI

Scope creep and not easy to maintain, let's just not have a UI.

Implement GoReleaser

I have found this very useful in other projects. Would like to implement it here to run automatically with GitHub Actions.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.