A cobra CLI client for the orchestra server API
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Arsen Musayelyan a7029369ef Fix panic when using `orc task ls` on specific node 3 months ago
cmd Fix panic when using `orc task ls` on specific node 3 months ago
.gitignore Initial Commit 3 months ago
LICENSE Initial Commit 3 months ago
README.md Add link to orchestra 3 months ago
go.mod Initial Commit 3 months ago
go.sum Initial Commit 3 months ago
main.go Initial Commit 3 months ago

README.md

orc

ORchestra Client

A cobra CLI client for the orchestra server API


Configuration

This assumes an orchestra server is already installed and running on an accessible port.

orc uses cobra and viper for its configuration. The server address can via the -s or --server-addr flags or by using a config file, ~/.orc.toml by default. The location of the config file can be set via the -c or --config flags. Since viper supports multiple config formats, any format is acceptable, for instance ~/.orc.yaml would also work.

To configure a server address in the config file, use the key serverAddr. If using TOML, the config would look like so:

serverAddr = "192.168.0.100:15183"

Usage

orc uses cobra and therefore works using commands. Invoking orc with no arguments will return the help message with all the available subcommands at the current level.

To get help with a subcommand, use orc help <subcommand(s)>.

Installation

orc can either be installed using go modules or manually by compiling and copying to /usr/bin.

To install using go modules, make sure $PATH and $GOPATH are set correctly, and then run:

go get gitea.arsenm.dev/Arsen6331/orc

To install manually, clone this repo and then run the following inside it:

go build
sudo install -Dm755 orc /usr/bin