CLI

The enclave command line interface provides a functional way to interact with the enclave agent. When installed, the CLI can be interacted with using the enclave binary. If the enclave command is not accessible, please make sure the binary is in your path.

Examples

Get the help menu for the CLI.

enclave --help

Get the version of your agent and installed plugins.

enclave version

Register your agent

enclave auth register

View the status of the agent

enclave status

Refresh your networking token

enclave auth refresh

Logout of your current agent

enclave auth logout

help

Display help for the commands.

update

Update plugins if an update is needed.

status

Get the status of the agent.

Flag	Description
-a, --all	See all agents that you are connected to.
--healthcheck	Perform a healthcheck on the agent. Returns a 0 status code if the agent is authenticated and a 1 if the agent is authenticated.

auth status

View the authentication status of your agent.

auth register

Start the agent. Without any flags, it will prompt to authenticate and choose your agent.

Flag	Description
--registration-code <registration-code>	Authenticate using a registration code.
--token <agent-token>	Authenticate using an agent token.
--emc-url	Endpoint of the EMC to interact with. This endpoint will be cached.

auth activate

Activate an agent with an activation code.

Flag	Description
--code <code>	Activation code.

auth login

Login to the agent with existing credentials.

auth refresh

Refresh your network authentication token if it expires.

auth logout

Logout of your session.

auth clear

Clear your cached authentication credentials.

logs

View logs from the agent.

Flag	Description
-f, --follow	Tail the logs.
-l, --limit	Number of logs to return (default: 100).
-v, --verbose	Output verbose logs.