kourou
Advanced tools
Readme
The CLI that helps you manage your Kuzzle instances.
:warning: This project is currently in beta and breaking changes may occur until the 1.0.0
$ npm install -g kourou
$ kourou COMMAND
running command...
$ kourou (-v|--version|version)
kourou/0.9.0 linux-x64 node-v12.16.1
$ kourou --help [COMMAND]
USAGE
$ kourou COMMAND
...
Commands that needs to send requests to Kuzzle API can specify the Kuzzle server address and authentication informations.
By command line:
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--username=username [default: anonymous] Kuzzle user
--password=password Kuzzle user password
--ssl [default: true for port 443] Use SSL to connect to Kuzzle
By environment variables:
KUZZLE_HOST [default: localhost] Kuzzle server host
KUZZLE_PORT [default: 7512] Kuzzle server port
KUZZLE_USERNAME [default: anonymous] Kuzzle user
KUZZLE_PASSWORD Kuzzle user password
KUZZLE_SSL Use SSL to connect to Kuzzle
kourou api-key:create USERkourou api-key:delete USERkourou api-key:search USERkourou collection:dump INDEX COLLECTIONkourou collection:restore PATHkourou document:create INDEX COLLECTIONkourou document:get INDEX COLLECTION IDkourou es:get INDEX IDkourou es:insert INDEXkourou es:list-indexkourou help [COMMAND]kourou index:dump INDEXkourou index:restore PATHkourou instance:logskourou instance:spawnkourou profile:dumpkourou profile:restore PATHkourou query CONTROLLER:ACTIONkourou role:dumpkourou role:restore PATHkourou vault:add SECRETS-FILE KEY VALUEkourou vault:encrypt FILEkourou vault:show SECRETS-FILE KEYkourou vault:test SECRETS-FILEkourou api-key:create USERCreates a new API Key for a user
USAGE
$ kourou api-key:create USER
ARGUMENTS
USER User kuid
OPTIONS
-d, --description=description (required) API Key description
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--expire=expire [default: -1] API Key validity
--help show CLI help
--id=id API Key unique ID
--password=password Kuzzle user password
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
See code: src/commands/api-key/create.ts
kourou api-key:delete USERDeletes an API key.
USAGE
$ kourou api-key:delete USER
ARGUMENTS
USER User kuid
OPTIONS
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--help show CLI help
--id=id API Key unique ID
--password=password Kuzzle user password
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
See code: src/commands/api-key/delete.ts
kourou api-key:search USERLists a user's API Keys.
USAGE
$ kourou api-key:search USER
ARGUMENTS
USER User kuid
OPTIONS
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--filter=filter Filter to match the API Key descriptions
--help show CLI help
--password=password Kuzzle user password
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
See code: src/commands/api-key/search.ts
kourou collection:dump INDEX COLLECTIONDump an entire collection content (JSONL format)
USAGE
$ kourou collection:dump INDEX COLLECTION
ARGUMENTS
INDEX Index name
COLLECTION Collection name
OPTIONS
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--batch-size=batch-size [default: 2000] Maximum batch size (see limits.documentsFetchCount config)
--help show CLI help
--password=password Kuzzle user password
--path=path Dump root directory (default: index name)
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
See code: src/commands/collection/dump.ts
kourou collection:restore PATHRestore the content of a previously dumped collection
USAGE
$ kourou collection:restore PATH
ARGUMENTS
PATH Dump directory path
OPTIONS
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--batch-size=batch-size [default: 200] Maximum batch size (see limits.documentsWriteCount config)
--collection=collection If set, override the collection destination name
--help show CLI help
--index=index If set, override the index destination name
--no-mappings Skip collection mappings
--password=password Kuzzle user password
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
See code: src/commands/collection/restore.ts
kourou document:create INDEX COLLECTIONCreates a document
USAGE
$ kourou document:create INDEX COLLECTION
ARGUMENTS
INDEX Index name
COLLECTION Collection name
OPTIONS
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--body=body [default: {}] Document body in JS or JSON format. Will be read from STDIN if available
--help show CLI help
--id=id Optional document ID
--password=password Kuzzle user password
--replace Replaces the document if it already exists
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
EXAMPLES
kourou document:create iot sensors --body '{network: "sigfox"}'
kourou document:create iot sensors < document.json
See code: src/commands/document/create.ts
kourou document:get INDEX COLLECTION IDGets a document
USAGE
$ kourou document:get INDEX COLLECTION ID
ARGUMENTS
INDEX Index name
COLLECTION Collection name
ID Document ID
OPTIONS
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--help show CLI help
--password=password Kuzzle user password
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
See code: src/commands/document/get.ts
kourou es:get INDEX IDGets a document from ES
USAGE
$ kourou es:get INDEX ID
ARGUMENTS
INDEX ES Index name
ID Document ID
OPTIONS
-h, --host=host [default: localhost] Elasticsearch server host
-p, --port=port [default: 9200] Elasticsearch server port
--help show CLI help
See code: src/commands/es/get.ts
kourou es:insert INDEXInserts a document directly into ES (will replace if exists)
USAGE
$ kourou es:insert INDEX
ARGUMENTS
INDEX ES Index name
OPTIONS
-h, --host=host [default: localhost] Elasticsearch server host
-p, --port=port [default: 9200] Elasticsearch server port
--body=body [default: {}] Document body in JSON
--help show CLI help
--id=id Document ID
See code: src/commands/es/insert.ts
kourou es:list-indexLists available ES indexes
USAGE
$ kourou es:list-index
OPTIONS
-g, --grep=grep Match output with pattern
-h, --host=host [default: localhost] Elasticsearch server host
-p, --port=port [default: 9200] Elasticsearch server port
--help show CLI help
See code: src/commands/es/list-index.ts
kourou help [COMMAND]display help for kourou
USAGE
$ kourou help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
kourou index:dump INDEXDump an entire index content (JSONL format)
USAGE
$ kourou index:dump INDEX
ARGUMENTS
INDEX Index name
OPTIONS
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--batch-size=batch-size [default: 2000] Maximum batch size (see limits.documentsFetchCount config)
--help show CLI help
--password=password Kuzzle user password
--path=path Dump directory (default: index name)
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
See code: src/commands/index/dump.ts
kourou index:restore PATHRestore the content of a previously dumped index
USAGE
$ kourou index:restore PATH
ARGUMENTS
PATH Dump directory or file
OPTIONS
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--batch-size=batch-size [default: 200] Maximum batch size (see limits.documentsWriteCount config)
--help show CLI help
--index=index If set, override the index destination name
--no-mappings Skip collections mappings
--password=password Kuzzle user password
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
See code: src/commands/index/restore.ts
kourou instance:logsDisplays the logs of a running Kuzzle
USAGE
$ kourou instance:logs
OPTIONS
-f, --follow Follow log output
-i, --instance=instance Kuzzle instance name
See code: src/commands/instance/logs.ts
kourou instance:spawnSpawn a new Kuzzle instance
USAGE
$ kourou instance:spawn
OPTIONS
-v, --version=version [default: 2] Core-version of the instance to spawn
--check Check prerequisite before running Kuzzle
--help show CLI help
See code: src/commands/instance/spawn.ts
kourou profile:dumpDumps Kuzzle profiles
USAGE
$ kourou profile:dump
OPTIONS
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--batch-size=batch-size [default: 2000] Maximum batch size (see limits.documentsFetchCount config)
--help show CLI help
--password=password Kuzzle user password
--path=path [default: profiles] Dump directory
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
See code: src/commands/profile/dump.ts
kourou profile:restore PATHRestores previously dumped Kuzzle profiles
USAGE
$ kourou profile:restore PATH
ARGUMENTS
PATH Dump file
OPTIONS
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--batch-size=batch-size [default: 200] Maximum batch size (see limits.documentsWriteCount config)
--help show CLI help
--password=password Kuzzle user password
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
See code: src/commands/profile/restore.ts
kourou query CONTROLLER:ACTIONExecutes an API query
USAGE
$ kourou query CONTROLLER:ACTION
ARGUMENTS
CONTROLLER:ACTION Controller and action (eg: "server:now")
OPTIONS
-a, --arg=arg Additional argument. Repeatable. (e.g. "-a refresh=wait_for")
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--body=body [default: {}] Request body in JS or JSON format. Will be read from STDIN if available.
--help show CLI help
--password=password Kuzzle user password
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
EXAMPLES
kourou query document:get --arg index=iot --arg collection=sensors --arg _id=sigfox-42
kourou query collection:create --arg index=iot --arg collection=sensors --body '{dynamic: "strict"}'
kourou query admin:loadMappings < mappings.json
echo '{name: "Aschen"}' | kourou query document:create --arg index=iot --arg collection=sensors
See code: src/commands/query.ts
kourou role:dumpDumps Kuzzle roles
USAGE
$ kourou role:dump
OPTIONS
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--batch-size=batch-size [default: 2000] Maximum batch size (see limits.documentsFetchCount config)
--help show CLI help
--password=password Kuzzle user password
--path=path [default: roles] Dump directory
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
See code: src/commands/role/dump.ts
kourou role:restore PATHRestores previously dumped Kuzzle roles
USAGE
$ kourou role:restore PATH
ARGUMENTS
PATH Dump file
OPTIONS
-h, --host=host [default: localhost] Kuzzle server host
-p, --port=port [default: 7512] Kuzzle server port
--batch-size=batch-size [default: 200] Maximum batch size (see limits.documentsWriteCount config)
--help show CLI help
--password=password Kuzzle user password
--ssl Use SSL to connect to Kuzzle
--username=username [default: anonymous] Kuzzle username (local strategy)
See code: src/commands/role/restore.ts
kourou vault:add SECRETS-FILE KEY VALUEAdds an encrypted key to a secrets file
USAGE
$ kourou vault:add SECRETS-FILE KEY VALUE
ARGUMENTS
SECRETS-FILE Encrypted secrets file
KEY Path to the key (lodash style)
VALUE Value to encrypt
OPTIONS
--vault-key=vault-key Kuzzle Vault Key (or KUZZLE_VAULT_KEY)
See code: src/commands/vault/add.ts
kourou vault:encrypt FILEEncrypts an entire file.
USAGE
$ kourou vault:encrypt FILE
ARGUMENTS
FILE File containing unencrypted secrets
OPTIONS
-f, --force Overwrite the output file if it already exists
-o, --output-file=output-file Output file (default: <file>.enc.json)
--vault-key=vault-key Kuzzle Vault Key (or KUZZLE_VAULT_KEY)
See code: src/commands/vault/encrypt.ts
kourou vault:show SECRETS-FILE KEYPrints an encrypted key.
USAGE
$ kourou vault:show SECRETS-FILE KEY
ARGUMENTS
SECRETS-FILE Encrypted secrets file
KEY Path to the key (lodash style)
OPTIONS
--vault-key=vault-key Kuzzle Vault Key (or KUZZLE_VAULT_KEY)
See code: src/commands/vault/show.ts
kourou vault:test SECRETS-FILETests if an encrypted secrets file can be decrypted.
USAGE
$ kourou vault:test SECRETS-FILE
ARGUMENTS
SECRETS-FILE Encrypted secrets file
OPTIONS
--vault-key=vault-key Kuzzle Vault Key (or KUZZLE_VAULT_KEY)
See code: src/commands/vault/test.ts
We liked the idea that this CLI is like a launchpad for the Kuzzle rocket. The place where you launch and pilot your Kuzzle instance. The place where the European Space Agency launches their rockets is in the country near the city of Kourou, in French Guiana, so we liked the idea that the Kuzzle rockets would take off from there.
FAQs
The CLI that helps you manage your Kuzzle instances
The npm package kourou receives a total of 25 weekly downloads. As such, kourou popularity was classified as not popular.
We found that kourou demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.
Security News
Results from the 2023 State of JavaScript Survey highlight key trends, including Vite's dominance, rising TypeScript adoption, and the enduring popularity of React. Discover more insights on developer preferences and technology usage.