CLI client for querying Regatta store
you can install regatta-client using Homebrew
brew tap tantalor93/regatta-client
brew install regatta-client
or using Go tooling
go install github.com/tantalor93/regatta-client@latest
or you can download the latest binary archive for your operating system and architecture here
you can also run regatta-client in a Docker container using provided image
docker run ghcr.io/tantalor93/regatta-client --version
Command-line tool wrapping API calls to Regatta (https://engineering.jamf.com/regatta/).
Simplifies querying for data in Regatta store and other operations.
Usage:
regatta-client [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
delete Delete data from Regatta store
help Help about any command
man Generates man pages
put Put data into Regatta store
range Retrieve data from Regatta store
table Print available tables
version Get current version of regatta-client and a Regatta server
Flags:
--cert string Regatta CA cert
--dial-timeout duration timeout for establishing the connection to the Regatta (default 2s)
--endpoint string Regatta API endpoint (default "localhost:8443")
-h, --help help for regatta-client
--insecure allow insecure connection, controls whether certificates are validated
--no-color disable color output
--timeout duration timeout for the Regatta operation (default 10s)
-v, --version version for regatta-client
Use "regatta-client [command] --help" for more information about a command.
this example retrieves all available tables in the Regatta store
regatta-client table
this example prints client and Regatta server version
regatta-client version
this example retrieves all records in the example-table
table
regatta-client range example-table
this example retrieves all records in the example-table
table without decoding binary data, this is achieved by using the --binary
flag. Retrieved key-value pairs are shown as Base64 strings
regatta-client range example-table --binary
this example retrieves a record with the key example-key
in the example-table
table
regatta-client range example-table example-key
this example retrieves all records with keys prefixed with example
in the example-table
table. Note the asterisk, when doing a prefix search! Without the asterisk, it is not a prefix search
regatta-client range example-table 'example*'
this example retrieves all records in provided lexicographic range [key, range_end)
, where range_end is exclusive.
range_end
must be lexicographically greater than key
regatta-client range example-table 1 3
this example deletes the record with the key example-key
in the example-table
table
regatta-client delete example-table example-key
this example deletes all records with keys prefixed with example
in the example-table
table. Note the asterisk, when doing prefix delete! Without the asterisk, it is not a prefix delete
regatta-client delete example-table 'example*'
this example deletes all records in the example-table
table
regatta-client delete example-table '*'
this example inserts (or updates existing record with the same key) into table example-table
a record with key example-key
and value example-value
regatta-client put example-table example-key example-value
to put binary data into Regatta using this tool, you need to encode the value using Base64 and use the --binary
flag,
For example, this inserts into table example-table
a record with key example-key
and value example-value
, where the value was
provided encoded as Base64 string
regatta-client put example-table example-key ZXhhbXBsZS12YWx1ZQ== --binary