summaryrefslogtreecommitdiff
path: root/cli/README
diff options
context:
space:
mode:
Diffstat (limited to 'cli/README')
-rw-r--r--cli/README22
1 files changed, 18 insertions, 4 deletions
diff --git a/cli/README b/cli/README
index 6572a52..1d6df82 100644
--- a/cli/README
+++ b/cli/README
@@ -1,10 +1,10 @@
# C2EC Management CLI
-This allows adding Providers and Terminals to the database using the command line.
+This cli allows adding Providers and Terminals to the database and deactivating terminals, using the command line.
-Before using the commands which connect to the database, you first need to connect to the database (can be done within the CLI using the `db` command).
+Before using the commands which connect to the database, you first need to connect to the database (can either be done setting `PGHOST` or within the CLI using the `db` command).
-It will take care of generating the access tokens for the terminal and hashing the authorization key of the provider backend.
+The CLI will take care of generating the access tokens for the newly registered terminal and hashing the authorization key of the provider backend.
## Build
@@ -12,4 +12,18 @@ It will take care of generating the access tokens for the terminal and hashing t
## Run
-`./c2ec-cli` \ No newline at end of file
+`./c2ec-cli`
+
+## Environment
+
+You can set `PGHOST` to connect automatically to the database.
+
+## Actions
+
+The cli offers following capabilities:
+
+Registering Wallee Provider: `rp`
+
+Registering a Wallee Termina: `rt`
+
+Deactivating a Terminal: `dt`