CLI Toolkit

Download the latest release for Windows, Linux or Osx

Configuration

If you want to target the local emulator specify the '--emulator true' flag.

./epoch get-account --emulator true

If you want to target the real api you must configure the cli toolkit with the api url, your account id and api key, there are two ways to do this:

Parameters

Each command takes the following parameters:

--url "https://api.epochflow.io/"
--account "<account_id>"
--key "<api_key>"

Environment variables

Windows:

setx epochflow_url "https://api.epochflow.io/"
setx epochflow_account "<account_id>"
setx epochflow_key "<api_key>"

Open a new terminal so the environment variables are updated.

Linux / Osx:

export epochflow_url="https://api.epochflow.io/"
export epochflow_account="<account_id>"
export epochflow_key="<api_key>"

Usage

# Accounts
./epoch get-account

# Sets
./epoch create-set --name "<set_name>" --collision-mode "<overwrite | combine>"
./epoch list-sets
./epoch get-set --id "<set_id>"
./epoch delete-set --id "<set_id>"

# Tags
./epoch list-tags --id "<set_id>"
./epoch delete-tag --id "<set_id>" --tag "<tag_name>"

# Data
./epoch get-data --id "<set_id>" --tag "<tag_name_1,tag_name_2>"

# Api Keys
./epoch create-key --name "<key_name>" --expiry "<datetime>" --admin "<True|False>" --all_set_operations "<Undefined | Read | Write>" --permissions "set_1_id;tag1,tag2;read,write&set_2_id;all;read"
./epoch get-key --id "<key_id>"
./epoch list-keys
./epoch enable-key --id "<key_id>"
./epoch disable-key --id "<key_id>"
./epoch delete-key --id "<key_id>"