@mimik/mimik-edge-cli
v2.1.0
Published
mimik's mim OE command line interface (CLI) for edge microservice developer.
Downloads
28
Readme
mimik-edge-cli
mimik edge engine command line interface (CLI) for edge microservice developer to utilize our edge engine.
Installation
npm install -g @mimik/mimik-edge-cliUsage
$ npm install -g @mimik/mimik-edge-cli
$ mimik-edge-cli COMMAND
running command...
$ mimik-edge-cli (--version)
@mimik/mimik-edge-cli/2.1.0 darwin-arm64 node-v24.9.0
$ mimik-edge-cli --help [COMMAND]
USAGE
$ mimik-edge-cli COMMAND
...Commands
mimik-edge-cli account associatemimik-edge-cli account get-edge-access-tokenmimik-edge-cli account get-edge-id-tokenmimik-edge-cli account get-memimik-edge-cli container deletemimik-edge-cli container deploymimik-edge-cli container listmimik-edge-cli help [COMMAND]mimik-edge-cli image deletemimik-edge-cli image deploymimik-edge-cli image list
mimik-edge-cli account associate
to associate local edge engine with access token to secure ownership of communication channel, either provides FILE PATH or TOKEN.
USAGE
$ mimik-edge-cli account associate [-t <value>] [-f <value>] [-k <value>] [-a <value>]
FLAGS
-a, --api-key-file=<value> path of file that contains API key for JSONRPC
-f, --token-file=<value> path of file that contains edge access token
-k, --api-key=<value> API key for JSONRPC
-t, --token=<value> edge access token obtained from CLI
DESCRIPTION
to associate local edge engine with access token to secure ownership of communication channel, either provides FILE
PATH or TOKEN.mimik-edge-cli account get-edge-access-token
to obtain edge access token with developer ID token obtained from developer console, either provides FILE PATH or TOKEN.
USAGE
$ mimik-edge-cli account get-edge-access-token [-t <value>] [-f <value>] [-k <value>] [-a <value>] [--use-mid-v1]
FLAGS
-a, --api-key-file=<value> path of file that contains API key for JSONRPC
-f, --token-file=<value> path of file that contains developer ID token from developer console
-k, --api-key=<value> API key for JSONRPC
-t, --token=<value> developer ID token from developer console
--use-mid-v1 get edge_access_token using mID v1
DESCRIPTION
to obtain edge access token with developer ID token obtained from developer console, either provides FILE PATH or
TOKEN.mimik-edge-cli account get-edge-id-token
to obtain edge ID token of local node
USAGE
$ mimik-edge-cli account get-edge-id-token [-k <value>] [-a <value>]
FLAGS
-a, --api-key-file=<value> path of file that contains API key for JSONRPC
-k, --api-key=<value> API key for JSONRPC
DESCRIPTION
to obtain edge ID token of local nodemimik-edge-cli account get-me
to obtain status of current node
USAGE
$ mimik-edge-cli account get-me
DESCRIPTION
to obtain status of current nodemimik-edge-cli container delete
to delete container runtime from edge engine microservice container management service.
USAGE
$ mimik-edge-cli container delete -i <value> [-t <value>] [-f <value>]
FLAGS
-f, --token-file=<value> path of file that contains edge access token
-i, --id=<value> (required) ID of container from edge engine microservice container management service
-t, --token=<value> edge access token obtained from CLI
DESCRIPTION
to delete container runtime from edge engine microservice container management service.mimik-edge-cli container deploy
to deploy edge microservice container runtime with access token to edge engine microservice container management service.
USAGE
$ mimik-edge-cli container deploy -p <value> [-t <value>] [-f <value>]
FLAGS
-f, --token-file=<value> path of file that contains edge access token
-p, --payload=<value> (required) path of the payload that describes the container runtime
-t, --token=<value> edge access token obtained from CLI
DESCRIPTION
to deploy edge microservice container runtime with access token to edge engine microservice container management
service.mimik-edge-cli container list
to list all edge microservice containers running on edge engine microservice container management service.
USAGE
$ mimik-edge-cli container list [-t <value>] [-f <value>]
FLAGS
-f, --token-file=<value> path of file that contains edge access token
-t, --token=<value> edge access token obtained from CLI
DESCRIPTION
to list all edge microservice containers running on edge engine microservice container management service.mimik-edge-cli help [COMMAND]
Display help for mimik-edge-cli.
USAGE
$ mimik-edge-cli help [COMMAND...] [-n]
ARGUMENTS
COMMAND... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for mimik-edge-cli.See code: @oclif/plugin-help
mimik-edge-cli image delete
to delete edge microservice image from edge engine microservice container management service.
USAGE
$ mimik-edge-cli image delete -i <value> [-t <value>] [-f <value>]
FLAGS
-f, --token-file=<value> path of file that contains edge access token
-i, --id=<value> (required) ID of microservice image from edge engine microservice container management
service
-t, --token=<value> edge access token obtained from CLI
DESCRIPTION
to delete edge microservice image from edge engine microservice container management service.mimik-edge-cli image deploy
to deploy edge microservice image with access token to edge engine microservice container management service.
USAGE
$ mimik-edge-cli image deploy -i <value> [-t <value>] [-f <value>]
FLAGS
-f, --token-file=<value> path of file that contains edge access token
-i, --image=<value> (required) path of the edge microservice image
-t, --token=<value> edge access token obtained from CLI
DESCRIPTION
to deploy edge microservice image with access token to edge engine microservice container management service.mimik-edge-cli image list
to list all edge microservice images on edge engine microservice container management service.
USAGE
$ mimik-edge-cli image list [-t <value>] [-f <value>]
FLAGS
-f, --token-file=<value> path of file that contains edge access token
-t, --token=<value> edge access token obtained from CLI
DESCRIPTION
to list all edge microservice images on edge engine microservice container management service.Environment Variable
mimik-edge-cli tool can utilize the following environment variables
| Name | Description | | --- | --- | EDGE_ENGINE_URI | The URI to the edgeEngine ex. 172.168.0.1:8083 | | MID_URL | The URL to the mID ex. http://mid.mimik360.com |
Below is an inline usage
$ EDGE_ENGINE_URI="172.168.0.1:8083" MID_URL="http://mid.mimik360.com" mimik-edge-cli account get-meIf you wish to provide the environment variables from a file, a .env file in the current folder can also be provided.
$ ls -a
. .. .env
$ cat .env
EDGE_ENGINE_URI=172.168.0.1:8083
MID_URL=http://mid.mimik360.com
$ mimik-edge-cli account get-me