README
¶
rostamctl 
rostamctl is a tool for interacting with RostamBot APIs via a command line interface.
Installation
The latest version can be installed using go get:
GO111MODULE="on" go get github.com/khos2ow/rostamctl@v0.2.0
NOTE: please use the latest go to do this, ideally go 1.12.9 or greater.
This will put rostamctl in $(go env GOPATH)/bin. If you encounter the error rostamctl: command not found after installation then you may need to either add that directory to your $PATH as shown here or do a manual installation by cloning the repo and run make build from the repository which will put rostamctl in:
$(go env GOPATH)/src/github.com/khos2ow/rostamctl/bin/$(uname | tr '[:upper:]' '[:lower:]')-amd64/rostamctl
Stable binaries are also available on the releases page. To install, download the binary for your platform from "Assets" and place this into your $PATH:
curl -Lo ./rostamctl https://github.com/khos2ow/rostamctl/releases/download/v0.2.0/rostamctl-$(uname)-amd64
chmod +x ./rostamctl
mv ./rostamctl /some-dir-in-your-PATH/rostamctl
NOTE: Windows releases are compressed in ZIP format.
Code Completion
The code completion for bash or zsh can be installed using:
Note: Shell auto-completion is not available for Windows users.
bash
rostamctl completion bash > ~/.rostamctl-completion
source ~/.rostamctl-completion
# or simply the one-liner below
source <(rostamctl completion bash)
zsh
rostamctl completion zsh > /usr/local/share/zsh/site-functions/_rostamctl
autoload -U compinit && compinit
To make this change permenant, the above commands can be added to your ~/.profile file.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
rostamctl
Package rostamctl implements root command
|
Package rostamctl implements root command |
|
rostamctl/completion
Package completion implements the `completion` command
|
Package completion implements the `completion` command |
|
rostamctl/completion/bash
Package bash implements the `bash` command
|
Package bash implements the `bash` command |
|
rostamctl/completion/zsh
Package zsh implements the `zsh` command
|
Package zsh implements the `zsh` command |
|
rostamctl/twitter
Package twitter implements the `twitter` command
|
Package twitter implements the `twitter` command |
|
rostamctl/twitter/check
Package check implements the `twitter check` command
|
Package check implements the `twitter check` command |
|
rostamctl/twitter/get
Package get implements the `twitter get` command
|
Package get implements the `twitter get` command |
|
rostamctl/twitter/list
Package list implements the `twitter list` command
|
Package list implements the `twitter list` command |
|
rostamctl/version
Package version implements the `version` command
|
Package version implements the `version` command |
|
pkg
|
|
|
api
Package api contains the definition of API client used in rostamctl
|
Package api contains the definition of API client used in rostamctl |
|
api/twitter
Package twitter contains implementation of Twitter API client
|
Package twitter contains implementation of Twitter API client |
|
cli
Package cli wraps around and holds the references to different part of rostamctl command
|
Package cli wraps around and holds the references to different part of rostamctl command |
|
flags
Package flags contains general utility of the rostamctl flags
|
Package flags contains general utility of the rostamctl flags |
|
output
Package output contains helper utility to build and format the output
|
Package output contains helper utility to build and format the output |
|
util
Package util contains general utility of the rostamctl
|
Package util contains general utility of the rostamctl |