README
Routr Command-Line Tool
The rctl
is a command-line interface for running commands against a Routr server. This overview covers rctl
syntax, describes the command operations and provides common examples. For details about each command, including all the supported flags and subcommands, see the reference documentation below. This tool ships separately from the Routr server.
Installation
To get the Routr Command-Line Tool run the following command:
npm install -g routr-ctl
The command-line tool is now globally accessible.
Alternatively, you can install the tool in seconds on Linux (Ubuntu and others) with:
sudo snap install rctl
Login to a Routr server
To login to a Routr server, use the login command.
rctl login https://127.0.0.1:4567/api/{apiVersion} -u admin -p changeit
The current API version is v1beta1
Syntax
Use the following syntax to run rctl
commands from your terminal window:
rctl COMMAND [REF] [flags]
where COMMAND
, subcommand
REF
, and flags
are:
COMMAND
: Specifies the operation that you want to perform on one or more resources. For example, create, get, delete, locate(loc).subcommand
: Specifies the resource type. Resource types are case-sensitive, and you can specify the singular, plural, or abbreviated forms. For example, the following commands produce the same output:
$ rctl get gateway gweef506
$ rctl get gateways gweef506
$ rctl get gw gweef506
REF
: Specifies the reference to the resource. References are case-sensitive. For a full list, omit the reference. For example,$ rctl get agents
.flags
: Specifies optional flags. For example, you can use the --filter to further reduce the output of theget
command .
The --filter flag uses JsonPath to perform the filtering. The root is always '