https://github.com/romainberger/kcals

A minimalist slack cli for when you don't want to quit your terminal to send one message.
https://github.com/romainberger/kcals

cli ink slack

Last synced: 11 days ago
JSON representation

A minimalist slack cli for when you don't want to quit your terminal to send one message.

• Host: GitHub
• URL: https://github.com/romainberger/kcals
• Owner: romainberger
• Created: 2019-03-26T16:23:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-05-08T10:56:39.000Z (over 3 years ago)
• Last Synced: 2024-10-13T01:15:19.788Z (26 days ago)
• Topics: cli, ink, slack
• Language: JavaScript
• Size: 238 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Kcals

A minimalist Slack cli for when you don't want to quit your terminal to send one message.

![Kcals](https://raw.githubusercontent.com/romainberger/kcals/master/kcals.gif)

## Installation

```shell

$ npm i -g kcals

```

On the first use, Kcals will ask you a token, generate one here: [https://api.slack.com/custom-integrations/legacy-tokens](https://api.slack.com/custom-integrations/legacy-tokens).

## Usage

```shell

$ kcals

```

When you'll start typing the name of the recipient a list of suggestion will be displayed. You can navigate through them with the up and down arrows, and select the one you want with enter.

You can also give the recipient and message directly:

```shell

$ # kcals [recipient] [message]

$ kcals @romain hello how are you

```

If there is a single match with the name provided, the message will be sent directly.

![Kcals](https://raw.githubusercontent.com/romainberger/kcals/master/kcals-2.gif)

You can also simply give the name of the recipient:

```shell

$ kcals @romain

```

## Autocompletion

To activate autocompletion with Kcals, copy the file `kcals-completion.bash` to your user directory then add this script to your `.bash_profile`:

```shell

if [ -f ~/kcals-completion.bash ]; then

    . ~/kcals-completion.bash

fi

```

You can now use Kcals with autocompletion for users:

![Kcals](https://raw.githubusercontent.com/romainberger/kcals/master/kcals-3.gif)

If you are using an alias for Kcals, you will need to add something else so autocompletion works with them: `__kcals_complete `. For example if the alias is `k`:

```shell

if [ -f ~/kcals-completion.bash ]; then

    . ~/kcals-completion.bash

    __kcals_complete k

fi

```

## Development

```shell

# clone the repo

# install the dependencies

$ yarn

# to test the cli run:

$ ./index.js

```

## Todo

- use cached users for main app (+ add an argument to clear cache if needed)

- fix display after config file creation (use ink)

- paste acte weird sometimes

- support new line with cmd + enter?

## License

MIT