Today we see CLI from everywhere, everybody wants it’s own CLI: Heroku, Vue.js, React, and so on.
Version française ici : https://blog.kuzzle.io/fr/kourou-cli-kuzzle
At Kuzzle we also wondered what we would get out of having a nice CLI full of features, because we were a bit fed up with curl and wscat.
So we started to develop a CLI to allow us to work more efficiently in our daily projects, and now we would like to officially share it with all our users :-)
Have you met Kourou ?
Kourou is therefore a command line interface that allows you to administer your Kuzzle.
But why Kourou? The French who read us may know this name: it is the launch base for the Ariane rockets in French Guiana.
It's a multi-command CLI that uses Oclif, Heroku's CLI framework, and bonus to be even more hype: we even developed it in Typescript.
Currently Kourou is still under heavy development and we are adding features every week.
Of course, these commands interact with the Kuzzle API by logging in and logging in, but not only that!
Let’s install it:
Launch a Kuzzle stack
The first command is of course a command that launches a complete Kuzzle stack!
You can even launch several of them, the port numbers will be automatically shifted (7512, 7513, ...).
And you can even see the logs of your instances ;-)
Manage your API keys
You may not know it but since Kuzzle v2 you can connect with API keys.
Given the simplicity, you have no more excuses not to use them ;-)
Dump and restore Kuzzle data
We all know the frustration of a bug present on the server but not reproducible locally because of database differences.
The format used is JSONL, portable and readable. Kourou handles large volumes, allowing millions of documents to be imported or exported easily.
Encrypting and decrypting the Vault
Using the Vault to share the secrets of a project is cool but using Kourou to manage it is totally hype!
You can easily add a key to an existing file without having to decrypt everything and then encrypt it again.
And if you have forgotten what was in a particular API key, you can display the content of a key in a single line.
Send API requests directly to Kuzzle
The Kuzzle API is quite huge and we're not going to reproduce it identically in Kourou (at least not right away).
And a lot of other things!
The complete list is available in the README on Github or by typing kourou --help
You'll have understood, Kourou is the tool you need to be even more productive with Kuzzle ;-)
If you have ideas of features to add, don't hesitate to propose it to us by opening an issue on Github!
Or even better, try to develop it yourself and do a PR, we love it :-)