Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 2.01 KB

README.md

File metadata and controls

49 lines (35 loc) · 2.01 KB

jrctl

Command line tool to help interact with our API

About

Our command-line tool will help you interact with the JetRails API. Services are currently limited because we are actively working on exposing our API to the public. Future versions of our CLI tool will extend functionality. Stay tuned!

Installation (MacOS)

$ brew tap jetrails/tap
$ brew install jrctl

Installation (RedHat)

$ rpm -i https://github.com/jetrails/jrctl/releases/download/latest/jrctl_latest_linux_amd64.rpm

Installation (Debian)

$ curl -sL -o /var/cache/apt/archives/jrctl_latest_linux_amd64.deb https://github.com/jetrails/jrctl/releases/download/latest/jrctl_latest_linux_amd64.deb
$ dpkg -i /var/cache/apt/archives/jrctl_latest_linux_amd64.deb
$ rm /var/cache/apt/archives/jrctl_latest_linux_amd64.deb

Building & Running

This project uses a simple Makefile as a build system.

Command Description
make build Build binaries and output to bin folder
make build-all Build for all platforms
make clean Delete built binaries
make docs Generate documentation
make package Package binary for many distributions
make format Format code with goimports
make help Display available commands

Configuration File

A configuration file is used to load user settings. It can be found in ~/.jrctl/config.yaml. Some features can be configured via environmental variables.