Comment on page
Client CLI Examples

All commands can be displayed by entering help at the session command prompt.
First startup
Master passphrase setup
[Master passphrase setup]
​
You have not setup a master passphrase.
A new one will be setup.
​
Please enter your desired master passphrase: 123456
Session wizard
[Add session]
​
Welcome to the session setup wizard!
Please follow the instructions below:
​
Enter new session identifier or enter "import" to import an exiting session.
Enter session identifier: session1
Create first EDV
Creating first EDV for session:
Enter provider url [http://localhost:7000]:
​
(you can just press enter here to go with the default,
otherwise, enter the remote URL)
EDV created: kGG5MGziJsak
Session "session1" was stored to local session saves.
The main CLI
[Session session1]
​
> session1 > 
Enter help for a list of all possible commands.
history shows the command history.
exit or quit will leave the interactive CLI.
Session management
Displaying information about the currently active session
> session1 > session info
​
[Session info]
​
ID:     session1
DID:    did:key:z6MkeVJPhuvkmKrXLdopdxbeX5XXQJSLaD4V21on9G9LY2Fa
Key ID: 187f31477eaa45978597c3520e1d5b8e
​
Linked EDVs:
1: kGG5MGziJsak @ http://localhost:7000
Exporting the currently active session
> session1 > session export
​
[Session export]
​
Exporting session "session1"...
​
Session token for "session1": eyJwMnM<snip>...
This session token is encrypted with your master passphrase.
The same master passphrase has to be used to decrypt the session token
  in the other client.
Switching the current active session
> session1 > session switch
​
[Select session]
​
Cached sessions:
- 1. session1
Type 'add' to add additional sessions using the session wizard.
​
Enter session identifier or index: 1
Importing a session from the session selection:
...
Enter session identifier or index: add
​
[Add session]
​
Welcome to the session setup wizard!
Please follow the instructions below:
​
Enter new session identifier or enter "import" to import an exiting session.
Enter session identifier: import
​
[Import session]
​
Enter session token: eyJwMnM...
Document management
Creating a document
> session1 > document create
Document identifier: doc1
Path/to/content.file: doc.txt
Generating file key...
Mapping chunks...
(Content size 30, chunks needed: 1)
Uploading EncryptedResourceStructure...
Done. Creating encrypted search index...
Uploading encrypted search index...
All done. File "doc1" is now stored to EDV "kGG5MGziJsak"!
Successfully created document!
Loading a document
> session1 > document load
Document identifier: doc1
Retrieved document "doc1" (below):
this is some document content
like document update.
Searching for a document
> session1 > document search
Enter keyword: content
Searchable Symmetric Encryption done.
Keyword "content" was found 1 time(s):
- 1. doc1
Deleting a document
> session1 > document delete
Document identifier: doc1
Successfully deleted document: doc1
Data requests
> session1 > datarequest
Enter data request: eyJraWQiOiI3ODE<snip>...
Verifying request...
Signature successfully verified.
​
[Job application]:
DID did:key:z6Mkmrm6<snip>GDGMd3SZk requests a EuropassCredential.
​
Do you want to accept at http://localhost:8000/accept-request/553bfe15-ed39-4bc9-b6f3-54ebb1a27b0d?
Accept request (y/n): y
Delegated permissions for EDV "kGG5MGziJsak" from owner "did:key:z6Mke<snip>Y2Fa" to child "did:key:z6M<snip>Zk"!
Transmitting acceptance respones...
Data request accepted!
ZCaps - Caveats Extension
Next - Usage / Examples
Client code examples
Last modified 1yr ago