Skip to content
You are reading Quorum Key Manager development version documentation and some displayed features may not be available in the stable release. You can switch to stable version using the version box at screen bottom.

Quorum Key Manager subcommands

This reference describes the syntax of the Quorum Key Manager (QKM) command line interface (CLI) subcommands.

You can specify QKM subcommands on the command line:

key-manager [COMMAND] [SUBCOMMAND] [OPTIONS]

sync

Locally indexes resources from a store.

ethereum

key-manager sync ethereum --manifest-path=<PATH> --store-name=<STRING> [--db-*]
key-manager sync ethereum --manifest-path="/config/default.yml" --store-name="eth-accounts" --db-database="postgres" --db-host=127.0.0.1 --db-port=6174

Indexes (adds references to) Ethereum accounts from the specified Ethereum store configured in the specified manifest file into your local QKM database.

You must specify:

  • The path of the manifest file using the --manifest-path option or the MANIFEST_PATH environment variable.
  • The name of the store from which to index the resources using the --store-name option or the STORE_NAME environment variable.

You can include any database options or environment variables (any options that begin with --db-).

keys

key-manager sync keys --manifest-path=<PATH> --store-name=<STRING> [--db-*]
key-manager sync keys --manifest-path="/config/default.yml" --store-name="hashicorp-keys" --db-database="postgres" --db-host=127.0.0.1 --db-port=6174

Indexes (adds references to) keys from the specified key store configured in the specified manifest file into your local QKM database.

You must specify:

  • The path of the manifest file using the --manifest-path option or the MANIFEST_PATH environment variable.
  • The name of the store from which to index the resources using the --store-name option or the STORE_NAME environment variable.

You can include any database options or environment variables (any options that begin with --db-).

secrets

key-manager sync secrets --manifest-path=<PATH> --store-name=<STRING> [--db-*]
key-manager sync secrets --manifest-path="/config/default.yml" --store-name="hashicorp-secrets" --db-database="postgres" --db-host=127.0.0.1 --db-port=6174

Indexes (adds references to) secrets from the specified secret store configured in the specified manifest file into your local QKM database.

You must specify:

  • The path of the manifest file using the --manifest-path option or the MANIFEST_PATH environment variable.
  • The name of the store from which to index the resources using the --store-name option or the STORE_NAME environment variable.

You can include any database options or environment variables (any options that begin with --db-).

Questions or feedback? You can discuss issues and obtain free support on Quorum Key Manager Discord channel.
For paid professional support by Consensys, contact us at [email protected].