CLI v0.0.1

2 min read

Important

The Edera Protect CLI is under active development. Options, Commands and Subcommands are subject to change.

Using the CLI 

protect [OPTIONS] <COMMAND>

Option reference

  • -c, --connection <CONNECTION> The connection URL to the Edera Protect daemon [default: unix:///var/lib/edera/protect/daemon.socket].
  • -h, --help Print help.
  • -v, --version Print version.

Tip

All commands and subcommands can be used with --help or -h for more information.

Command reference

zone

Manage the zones.

protect zone <COMMAND>

Commands:

  • attach Attach to the zone console.
  • list List zone information.
  • launch Launch a new zone.
  • destroy Destroy a zone.
  • exec Execute a command inside the zone.
  • logs View the logs of a zone.
  • metrics Read metrics from the zone.
  • top Dashboard for running zones.
  • watch Watch for zone changes.
  • update-resources Update the available resources to a zone.

View the protect zone documentation.

workload

Manage the workloads.

protect workload <COMMAND>

Commands:

  • launch Launch a new workload.
  • exec Execute a command inside the workload.
  • attach Attach to a workload console.
  • start Start a workload.
  • stop Stop a workload.
  • destroy Destroy a workload.
  • list List workload information.
  • watch Watch for workload changes.

View the protect workload documentation.

image

Manage the images.

protect image <COMMAND>

Commands:

  • pull Pull an image into the cache.
  • import Import an image into the cache.
  • remove Remove an image from the cache.
  • list List cached images.

View the protect image documentation.

network

Manage the network.

protect network <COMMAND>

Commands:

View the protect network documentation.

device

Manage the devices.

protect device <COMMAND>

Commands:

  • list List device information.

View the protect device documentation.

host

Manage the host of Edera Protect.

protect host <COMMAND>

Commands:

View the protect host documentation.

completion

Output shell completion code for the specified shell.

protect completion <SHELL>

Arguments:

  • <SHELL> Possible values: bash, elvish, fish, powershell, zsh.

View the protect completion documentation.

Last updated on