CLI Reference
znuny-cli commands for interactive Znuny webservice and user setup.
Znuny CLI reference
The znuny-cli entry point ships with pip install znuny and wraps the setup wizard with Znuny-specific console paths.
Commands
| Command | Description |
|---|---|
znuny-cli setup-system | Interactive webservice and user setup on a Znuny server |
Run on the Znuny application server with administrator access.
Example
pip install znuny
znuny-cli setup-systemThe wizard:
- Detects Znuny
- Creates an API user and queue permissions
- Generates GenericInterface webservice YAML
- Imports the configuration via
otrs.Console.pl
When to use the CLI vs Python client
| Task | Tool |
|---|---|
| First-time webservice setup on the server | znuny-cli setup-system |
| Ticket automation from your app | ZnunyClient in Python |