Skip to main content

cli

cli​

Trirematics commandline interface

Synopsis​

Trirematics CLI is a command line interface to interact with the Trirematics platform.

Configuration Files​

For accessing to your cluster, Trirematics CLI needs to know the Kubernetes configuration file. By default, Trirematics CLI looks for the file in the following locations:

  • $HOME/snap/br-t9s/current/.kube/config
  • where the variable $KUBECONFIG is pointing to
danger

Please note that if you are using Snap package, then you need to make sure your provided path is accessible to the Snap. It should be under one of the following directories:

  • $HOME/snap/br-t9s/current
  • /var/snap/br-t9s/current
  • $HOME/snap/br-t9s/common
  • /var/snap/br-t9s/common
tip

You could find a copy of your Kubernetes configuration file in the USB drive provided to you beside BubbleRAN package. You could always recover this file from your master by running:


kubectl config view --raw

or by copying it from /etc/kubernetes/admin.conf.

The file provided to the

--config flag could be used to encapsulate all the parameters that you want to pass to the commandline using JSON, YAML, or TOML. The file should be named 'config.json', 'config.yaml', or 'config.toml' and placed in one of the following locations or given as --config flag:

  • /etc/trirematics/cli
  • $HOME/.t9s/cli
  • current directory Checkout Viper documentation for more information.

Environment Variables​

This CLI is built using Cobra and Viper libraries in Golang. You could use environment variables in the format of

T9S_CLI_param=value to set value for a certain input parameter. For example, T9S_CLI_NAMESPACE

will set the value of

namespace parameter in the whole environment and becomes the default value for all commands. You could have these variables set into your shell environment or use the export command to set them in the current shell session.

Examples​

cli --version

Options​

  -c, --config string      config file (default "config.json")
  -h, --help               help for cli
  -n, --namespace string   namespace to perform the operations (default "trirematics")
  -v, --verbose            debug output

SEE ALSO​

  • cli cic - CLI-in-CLI
  • cli diag - Perform diagnostics against the cluster
  • cli extract - Extract contents from the containers
  • cli install - Install a component on Trirematics
  • cli list - List all the operators, models, or networks
  • cli login - Authenticate to Harbor for the current namespace
  • cli observe - Open up the observation toolbox
  • cli remove - Remove a component on Trirematics
  • cli run - Run an arbitrary command list
  • cli test - Perform an evaluation
Auto generated by spf13/cobra on 16-Feb-2024​