Command Line Interface¶

A command line interface (CLI) is provided to help managing the kwai system. To run the cli, use the kwai_cli.py script:

kwai_cli.py --help

`bus` ¶

bus contains subcommands for the event bus.

Command for showing the active database settings.

Parameters:

Name	Type	Description	Default
`password`	`bool`	show or hide the password (default is hide).	`typer.Option(False, help='Show the password')`

Command for testing the redis connection.

db contains subcommands for the database.

Command for showing the active database settings.

Parameters:

Name	Type	Description	Default
`password`	`bool`	show or hide the password (default is hide).	`typer.Option(False, help='Show the password')`

Command for testing the database connection.

Identity contains all subcommands for managing identity in kwai.

Note

Make sure the environment variable KWAI_SETTINGS_FILE is set!

Create a user account.

Use this command to create a new user account (for the root user for example).

Parameters:

Name	Type	Description	Default
`email`	`str`	The email address of the new user	`typer.Option(..., help='The email address of the new user', prompt=True)`
`first_name`	`str`	The firstname of the new user	`typer.Option(..., help='The first name of the new user', prompt=True)`
`last_name`	`str`	The lastname of the new user	`typer.Option(..., help='The last name of the new user', prompt=True)`
`password`	`str`	The password of the new user	`typer.Option(..., prompt=True, confirmation_prompt=True, hide_input=True)`