CLI | Command Line Interface

Run different functionalities of the Storage Kit by executing individual commands.

Installation & Running the Project

Make sure you have Docker or a JDK 16 build environment including Gradle installed on your machine

Docker

1. Clone the project

git clone https://github.com/walt-id/waltid-storage-kit.git

2. Change folder

cd waltid-storage-kit/

3. Build docker container

docker build -t storagekit .

4. Run the project

docker run storagekit

Find other build options for docker here.

Local

1. Clone the project

git clone https://github.com/walt-id/waltid-storage-kit.git

2. Change folder

cd waltid-storage-kit/

3. Build the project (other build options)

./storagekit.sh build

4. Set an alias

To make it more convient to use, you can also set an alias as follows for the executable:

alias storagekit="./build/distributions/waltid-storagekit-1.0-SNAPSHOT/bin/waltid-storagekit"

5. Use the CLI

storagekit client

Examples

See also: Client CLI examples

Document options (document, doc, d):
  - document load   - Load a document from this EDV, cache it locally (gets updated automatically on notification)
  - document create - Create (sequence 0) a new document in this EDV and publish it to to EDV peers (e.g. backups)
  - document update - Recreate, resequence, and publish update to EDV peers (e.g. backups)
  - document delete - Unlink document from EDV, optionally remove all backups at replica nodes (notify peers)
  - document purge  - Purge document in all versions from EDV, optionally remove all backups at replica nodes (notify peers)
  - document cache  - Show cached documents
  - document search - Start remote-run encrypted-search operation

Index options (index, i):
  - index tree      - Displays the whole index tree (all EDVs, all documents)
  - index show      - Displays the index of the selected EDV
  - index documents - Filters the index of the selected EDV to base documents

EDV options (edv, e):
  - edv delegate - Delegate certain permissions to another keypair
  - edv add      - Create a new EDV to add to the session
  
  - Notification options:
    - edv notifications connect    - Connect to the notification channel for this EDV
    - edv notifications disconnect - Disconnect from the notification channel for this EDV

Data request options (datarequest, dr):
  - datarequest - Accept a data request

Session options (session, s):
  - session info   - Display stored information about the current session
  - session export - Exports the current session to use on another device, or as a backup
  - session switch - Switch to another session

Client options:
  - help/?    - Show this help
  - history   - Show command history
  - exit/quit - Quit the Confidential Storage Interactive Console Interface
                
> sess01 >