https://github.com/mhughdo/nm5k
The command line interface for sending message to chatwork.
https://github.com/mhughdo/nm5k
chatwork golang
Last synced: 5 months ago
JSON representation
The command line interface for sending message to chatwork.
- Host: GitHub
- URL: https://github.com/mhughdo/nm5k
- Owner: mhughdo
- License: apache-2.0
- Created: 2020-08-31T15:40:05.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-30T03:30:05.000Z (about 5 years ago)
- Last Synced: 2026-01-12T01:34:36.073Z (5 months ago)
- Topics: chatwork, golang
- Language: Go
- Homepage:
- Size: 52.7 KB
- Stars: 35
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
no more 5k
```
nm5 is a command line interface (CLI) that ensure you won't lose 5000VND (anymore).
Usage:
nm5 [command]
nm5 [flags]
Available Commands:
config Show all configs
cron Run a cron job that automatically send message at 16:46
help Get help about any command
run Send message
set-cookie Set cookie in config file to send message
set-token Set token in config file (automatically set token using cookie if no arguments are passed) to send message
set-room Set room id
Flags:
-h Get helo about any command (work with all commands)
Use "nm5 [command] -h" for more information about a command.
```
- [Installing `nm5`](#installing-nm5)
- [Downloading a Release from GitHub](#downloading-a-release-from-github)
- [Building the Development Version from Source](#building-the-development-version-from-source)
- [Configuring Default Values](#configuring-default-values)
- [Uninstalling `nm5`](#uninstalling-nm5)
- [Examples](#examples)
## Installing `nm5`
### Downloading a Release from GitHub
Visit the [Releases page](https://github.com/mhughdo/nm5/releases) for the
[`nm5` GitHub project](https://github.com/mhughdo/nm5), and find the appropriate archive for your operating system and
architecture. Download the archive from from your browser or copy its URL and retrieve it to your home directory with
`wget` or `curl`.
For example, with `wget`:
```
cd ~
wget https://github.com/mhughdo/nm5/releases/download/v/nm5__linux_amd64.tar.gz
```
Or with `curl`:
```
cd ~
curl -OL https://github.com/mhughdo/nm5/releases/download/v/nm5__linux_amd64.tar.gz
```
Extract the binary:
```
tar xf ~/nm5__linux_amd64.tar.gz
```
Or download, extract and move to bin folder with this oneliner:
```
curl -sL https://github.com/mhughdo/nm5/releases/download/v/nm5__linux_amd64.tar.gz | tar -xzv && sudo mv nm5 /usr/local/bin
```
where `` is the full semantic version, e.g., `1.1.2`.
Move the `doctl` binary to somewhere in your path. For example, on GNU/Linux and OS X systems:
```
sudo mv ~/nm5 /usr/local/bin
```
Window version is not supported yet.
### Building the Development Version from Source
If you have a Go environment configured, you can install the development version of `nm5` from the command line.
```
go get github.com/mhughdo/nm5
```
While the development version is a good way to take a peek at `nm5`'s latest features before they get released, be aware
that it may have bugs. Officially released versions will generally be more stable.
## Configuring Default Values
The `nm5` configuration file is stored at \$HOME/.no-more-5k.yaml
You can directly change the config file but make sure file format stays the same.
Save and close the file. The next time you use `nm5`, the new default values you set will be in effect.
## Uninstalling `nm5`
Remove binary file (if you already move it to /usr/local/bin bin folder)
```
rm -rf /usr/local/bin/nm5
```
Remove config file
```
rm -rf $HOME/.no-more-5k.yaml
```
## Examples
Below are a few common usage examples.
- Send message:
```
nm5 run
```
- Set cron job:
```
nm5 cron
```
- Get help about set cookie command:
```
nm5 sc -h
```
- Set cookie:
```
nm5 sc 3tg2ku3a4vs2jmofu6paptrcne
```
- Set token:
```
nm5 st or nm5 st b229775d5036c15990287c7979d84a511e4096235f51f6779dca7
```
- Set room id (default: 195722902):
```
nm5 sr 195722902
```