Edge Command Line Interface (CLI)

Important  This feature is available only in the latest user interface.

The Edge Command Line Interface (CLI) is a tool that allows you to set up and manage aspects of your Edge site and is included when you download the Edge site installer.

If you need to reinstall or update the Edge CLI, you can run the following command in the Edge tool:

edge download-edgecli

Note Edge CLI is only available on Linux.

  • K3S
  • Managed Kubernetes

How you can use the Edge CLI commands on k3S

Action Definition
Setup and use Vaults with your Edge site

Vault commands are dependent on which vault and authentication method you use. Visit the dedicated pages to learn what the Edge CLI commands are to:
Setup and manage shared files for the Shared Storage connection

The Shared Storage connection for technical lineage allows you to access data source files from a shared folder.

To setup and manage the folder and files used for the Shared Storage connection, use the following commands in the Edge CLI:

  • Upload a shared folder which contains multiple data source files:
    $ .edgecli objects folder-upload
--source <source-string>
--target <target-string>
--ttlSeconds <time>
    KeyDefinition
    <source-string>The data source file you want to upload for your Shared Storage connection.
    <target-string>The folder in your Edge site where you want to store the shared folder and files.
    Note This folder does not have to already exist in your Edge site. If it does not, a folder with the name entered here will be created in your Edge site, containing the folder and files you have uploaded.
    <time> (optional)The time delay until the file is live, 15552000.
  • Upload a single shared data source file:
    $ ./edgecli objects file-upload 
--source <source-string>
--target <target-string>
--key <key-string>
--ttlSeconds <time>
    KeyDefinition
    <source-string>The data source file you want to upload for your Shared Storage connection.
    <target-string>The folder in your Edge site where you want to store the shared file.
    Note This folder does not have to already exist in your Edge site. If it does not, a folder with the name entered here will be created in your Edge site, containing the file you have uploaded.
    <key-string>The key used in edge-sdk getObject.
    <time> (optional)The time delay until the file is live, 15552000.
  • Pull a list of all folders and files that have been uploaded to your Edge site:
    $ ./edgecli objects folder-list
  • Delete a shared folder or file from your Edge site:
    $ ./edgecli objects folder-delete
--target <target-string>
    KeyDefinition
    <target-string>The name of the Edge shared folder you want to delete from your Edge site.

Select the managed Kubernetes cluster your Edge site is installed on:

Managed Kubernetes cluster

How to use Edge CLI commands on EKSAKSAWS Fargate using EKSGKEOpenShift

Actions Definitions
Install an Edge site You can install your Edge site on a managed Kubernetes cluster by following the steps outlined in the Install an Edge site page, in addition to running the following command: 
./edgecli install
Setup and use Vaults with your Edge site

Vault commands are dependent on which vault and authentication method you use. Visit the dedicated pages to learn what the Edge CLI commands are to:
Setup and manage shared files for the Shared Storage connection

The Shared Storage connection for technical lineage allows you to access data source files from a shared folder.

To setup and manage the folder and files used for the Shared Storage connection, use the following commands in the Edge CLI:

  • Upload a shared folder which contains multiple data source files:
    $ .edgecli objects folder-upload
--source <source-string>
--target <target-string>
--ttlSeconds <time>
    KeyDefinition
    <source-string>The data source file you want to upload for your Shared Storage connection.
    <target-string>The folder in your Edge site where you want to store the shared folder and files.
    Note This folder does not have to already exist in your Edge site. If it does not, a folder with the name entered here will be created in your Edge site, containing the folder and files you have uploaded.
    <time> (optional)The time delay until the file is live, 15552000.
  • Upload a single shared data source file:
    $ ./edgecli objects file-upload 
--source <source-string>
--target <target-string>
--key <key-string>
--ttlSeconds <time>
    KeyDefinition
    <source-string>The data source file you want to upload for your Shared Storage connection.
    <target-string>The folder in your Edge site where you want to store the shared file.
    Note This folder does not have to already exist in your Edge site. If it does not, a folder with the name entered here will be created in your Edge site, containing the file you have uploaded.
    <key-string>The key used in edge-sdk getObject.
    <time> (optional)The time delay until the file is live, 15552000.
  • Pull a list of all folders and files that have been uploaded to your Edge site:
    $ ./edgecli objects folder-list
  • Delete a shared folder or file from your Edge site:
    $ ./edgecli objects folder-delete
--target <target-string>
    KeyDefinition
    <target-string>The name of the Edge shared folder you want to delete from your Edge site.

Access help

If you need any help with the command parameters, you can run the help command for any of the supported Edge CLI commands. The help command is the Edge CLI command with the addition of -h.

For example, running the following command will return help information for the delete shared folder command for the Shared Storage connection:

$ ./edgecli objects folder-delete -h
Deletes shared folder that was uploaded, if it exists
			
Usage:
  edgecli objects folder-delete [flags]
			
Flags:
      --target string   The folder name specified in edge (DGC)
			
Global Flags:
  -h, --help