https://github.com/nonchalant/kikanbo
Command line tool for managing device connection status
https://github.com/nonchalant/kikanbo
cli cobra go golang slack-bot
Last synced: 2 months ago
JSON representation
Command line tool for managing device connection status
- Host: GitHub
- URL: https://github.com/nonchalant/kikanbo
- Owner: Nonchalant
- License: mit
- Created: 2018-05-20T17:15:10.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-07T02:29:07.000Z (over 6 years ago)
- Last Synced: 2025-04-12T02:12:50.519Z (2 months ago)
- Topics: cli, cobra, go, golang, slack-bot
- Language: Go
- Homepage:
- Size: 1010 KB
- Stars: 15
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kikanbo
kikanbo is command line tool for managing device connection status.
And [kikanbo](http://kikanbo.co.jp/english) is noodle I love 🍜
You can know current device connection status by mention on slack.
## Requirements
- [Go](https://golang.org/)
- [Slack Bot](https://my.slack.com/services/new/bot)
## Installation
```
$ brew install go // If not installed
$ export PATH=${HOME}/go/bin:${PATH} or export PATH=${GOPATH}/bin:${PATH}
$ go get -u github.com/Nonchalant/kikanbo
```
## Setup
Prepare `.env` file.
```
KIKANBO_TOKEN=xoxb-xxxxxxxxxx-xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
BOT_MEMBER_ID=
DEVICES_FILE_DIR=$HOME/.kikanbo // Option
DEVICES_FILE_PATH=$HOME/.kikanbo/devices.json // Option
```
### KIKANBO_TOKEN
Slack Bot Token
### BOT_MEMBER_ID
Slack Bot Member Id. You can get on slack app.
### DEVICES_FILE_DIR
Device List File Dir. Default is `$HOME/.kikanbo`.
### DEVICES_FILE_PATH
Device List File Path. Default is `$HOME/.kikanbo/devices.json`.
## Usage
### Command
```
$ kikanbo run
```
### Slack
#### Defaults
e.g. `@kikanbo`
Show all devices.
#### Keyword
e.g. `@kikanbo iOS 10`
Show devices contains keyword (e.g. `iOS 10`)
## Notice
kikanbo is depends on macOS commands `instruments`. Please run on macOS.
## Development
```
$ go get -u github.com/Nonchalant/kikanbo
$ cd ~/.go/github.com/Nonchalant/kikanbo
$ go run main.go run
```