kamihi⚓︎
Kamihi CLI utility. This utility provides commands to manage and interact with the Kamihi framework.
Usage⚓︎
kamihi [OPTIONS] COMMAND [ARGS]...
Arguments⚓︎
No arguments available
Options⚓︎
| Name | Description | Required | Default |
|---|---|---|---|
--config FILE |
Path to the Kamihi configuration file [default: (kamihi.yaml)] | No | - |
--help |
Show this message and exit. | No | - |
version |
Print the version and exit. | No | - |
init |
Initialize a new Kamihi project. | No | - |
run |
Run a project with the Kamihi framework. | No | - |
Sub Commands⚓︎
kamihi version⚓︎
Print the version and exit.
Usage⚓︎
kamihi version [OPTIONS]
Arguments⚓︎
No arguments available
Options⚓︎
| Name | Description | Required | Default |
|---|---|---|---|
--help |
Show this message and exit. | No | - |
kamihi init⚓︎
Initialize a new Kamihi project.
Usage⚓︎
kamihi init [OPTIONS] NAME
Arguments⚓︎
| Name | Description | Required |
|---|---|---|
NAME |
Name of the project. | Yes |
Options⚓︎
| Name | Description | Required | Default |
|---|---|---|---|
--path DIRECTORY |
Path to the project directory. | No | - |
--description TEXT |
Description of the project. [default: Kamihi project] | No | - |
--help |
Show this message and exit. | No | - |
kamihi action⚓︎
No description available
Usage⚓︎
kamihi action new [OPTIONS] NAME
Arguments⚓︎
| Name | Description | Required |
|---|---|---|
NAME |
Name of the new action. | Yes |
Options⚓︎
| Name | Description | Required | Default |
|---|---|---|---|
--help |
Show this message and exit. | No | - |
new |
Create a new action. | No | - |
--description TEXT |
Description of the new action. | No | - |
--help |
Show this message and exit. | No | - |
kamihi run⚓︎
Run a project with the Kamihi framework.
Usage⚓︎
kamihi run [OPTIONS]
Arguments⚓︎
No arguments available
Options⚓︎
| Name | Description | Required | Default |
|---|---|---|---|
-l, --log-level [TRACE|DEBUG|INFO|SUCCESS|WARNING|ERROR|CRITICAL] |
Set the logging level for console loggers. [default: (INFO)] | No | - |
-h, --host TEXT |
Host of the admin web panel [default: (localhost)] | No | - |
-p, --port INTEGER RANGE |
Port of the admin web panel [default: (4242); 1024<=x<=65535] | No | - |
--help |
Show this message and exit. | No | - |
kamihi user⚓︎
No description available
Usage⚓︎
kamihi user add [OPTIONS] TELEGRAM_ID
Arguments⚓︎
| Name | Description | Required |
|---|---|---|
TELEGRAM_ID |
Telegram ID of the user | Yes |
Options⚓︎
| Name | Description | Required | Default |
|---|---|---|---|
--help |
Show this message and exit. | No | - |
add |
Add a new user. | No | - |
-a, --admin |
Is the user an admin? | No | - |
-d, --data TEXT |
Additional data for the user in JSON format. For use with custom user classes. | No | - |
--help |
Show this message and exit. | No | - |