Akord Command Line Interface - simply interact with Akord from the terminal.
The CLI is a set of Akord commands for creating vaults, adding members, creating new stacks, etc.
The CLI uses Akord Client to create the encryption context and handle transaction formatting.
Each command is an interaction with the Akord Vault Protocol.
requires Node.js 16
yarn global add @akord/akord-cli
First configure the CLI with your Akord account
akord login <email>
Now let's create our first vault and upload our first file to a folder by following these few simple steps
akord vault:create "my first vault"
akord folder:create <vaultId> "my first folder"
akord stack:create <vaultId> --file-path "./image.jpeg" --parent-id <folderId>
_ _ _
/ \ | | __ ___ _ __ __| |
/ _ \ | |/ / / _ \ | '__| / _` |
/ ___ \ | < | (_) | | | | (_| |
/_/ \_\ |_|\_\ \___/ |_| \__,_|
akord <command>
Commands:
akord login <email> login & import the Akord wallet
akord signup <email> signup & generate the Akord wallet
akord vault:create <name> [terms] create a new vault
akord vault:rename <vaultId> <name> update vault name
akord vault:archive <vaultId> archive the vault
akord vault:restore <vaultId> restore the vault
akord stack:create <vaultId> create a new stack
akord stack:rename <stackId> <name> rename the stack
akord stack:upload-revision <stackId> upload new file version to the stack
akord stack:move <stackId> move the stack
<parentId>
akord stack:revoke <stackId> revoke the stack
akord stack:restore <stackId> restore the stack
akord stack:delete <stackId> delete the stack
akord memo:create <vaultId> <message> create a new memo
akord folder:create <vaultId> <name> create a new folder
[parentId]
akord folder:move <folderId> move the folder
<parentId>
akord folder:rename <folderId> <name> rename the folder
akord folder:revoke <folderId> revoke the folder
akord folder:restore <folderId> restore the folder
akord folder:delete <folderId> delete the folder
akord membership:invite <vaultId> invite a new member to the vault
<email>
akord membership:accept <membershipId> accept the invitation to the vault
akord membership:reject <membershipId> reject the invitation to the vault
or leave the vault
akord membership:revoke <membershipId> revoke the membership
akord vault:list list all vaults
akord vault:show <vaultId> show vault content
akord stack:list <vaultId> list all stacks within the given
vault
akord stack:show <stackId> show stack content
akord folder:list <vaultId> list all folders within the given
vault
akord folder:show <folderId> show folder content
akord stack:download <stackId> download latest file stack version
Options:
--version Show version number [boolean]
--help Show help [boolean]
yarn install
yarn build
yarn local
Please use sematinc commit messages