CLI Commands
The executable is testbench-defect-service. All commands support --help for detailed usage.
testbench-defect-service [COMMAND] [OPTIONS]
Commands overview
| Command | Description |
|---|---|
init | Interactive wizard to create a new configuration file from scratch. |
configure | Create or update an existing configuration interactively. |
set-credentials | Set the service username and password. |
start | Start the defect service. |
init
Create a new configuration file with an interactive wizard.
The wizard guides you through:
- Service settings (host, port)
- Credential setup (username, password)
- Client selection (JSONL or Jira)
- Client-specific configuration
testbench-defect-service init [--path PATH]
Options
| Option | Description | Default |
|---|---|---|
--path PATH | Path to the configuration file to create | config.toml |
Examples
# Create config.toml in the current directory
testbench-defect-service init
# Create config at a custom path
testbench-defect-service init --path /etc/defect-service/config.toml
configure
Update an existing configuration file interactively.
testbench-defect-service configure [OPTIONS]
Options
| Option | Description |
|---|---|
--path PATH | Path to the configuration file to update (default: config.toml) |
--full | Run the full configuration wizard (skip the menu) |
--service-only | Configure service settings only (host, port, debug) |
--credentials-only | Configure credentials only (username, password) |
--client-only | Configure client settings only |
--view | View the current configuration |
Examples
# Interactive menu (default)
testbench-defect-service configure
# Update only service settings
testbench-defect-service configure --service-only
# View current configuration
testbench-defect-service configure --view
set-credentials
Set or update the HTTP Basic Auth credentials used to protect API endpoints. This command generates a secure password hash and salt and stores them in your configuration file.
testbench-defect-service set-credentials [OPTIONS]
Options
| Option | Description |
|---|---|
--config PATH | Path to the configuration file (default: config.toml) |
--username TEXT | Username (prompts interactively if not provided) |
--password TEXT | Password (prompts interactively if not provided) |
Examples
# Interactive (prompts for credentials)
testbench-defect-service set-credentials
# Non-interactive
testbench-defect-service set-credentials --username admin --password "s3cret!"
Security
Avoid passing passwords as command-line arguments in shared or audited environments, as they may appear in shell history. Prefer the interactive prompt or use an environment variable pipeline.
start
Start the defect service.
testbench-defect-service start [OPTIONS]
Options
| Option | Description | Default |
|---|---|---|
--config PATH | Path to the configuration file | config.toml |
--client-class TEXT | Client class name or module path (overrides config) | from config |
--client-config PATH | Path to client configuration file (overrides config) | from config |
--host HOST | Host to bind to | 127.0.0.1 |
--port PORT | Port to listen on | 8030 |
--dev | Run in development mode (debug + auto reload) | off |
--ssl-cert PATH | Path to SSL certificate file for HTTPS | — |
--ssl-key PATH | Path to SSL private key file for HTTPS | — |
--ssl-ca-cert PATH | Path to CA certificate file for client verification (mTLS) | — |
Command-line arguments take precedence over configuration file settings.
Built-in client class names
When using --client-class, you can specify:
JsonlDefectClient— for JSONL file storageJiraDefectClient— for Jira Cloud / Data Center
Or provide a custom client (e.g. custom_client.py or custom_client.CustomClass).
Examples
# Start with defaults
testbench-defect-service start
# Development mode
testbench-defect-service start --dev
# Override host and port
testbench-defect-service start --host 0.0.0.0 --port 9000
# Use a different client
testbench-defect-service start --client-class JiraDefectClient --client-config jira.toml
# Use a custom client class
testbench-defect-service start --client-class custom_client.CustomDefectClient
# Start with HTTPS
testbench-defect-service start --ssl-cert certs/server.crt --ssl-key certs/server.key
# Start with mutual TLS (mTLS)
testbench-defect-service start --ssl-cert certs/server.crt --ssl-key certs/server.key --ssl-ca-cert certs/ca.crt
Getting help
# General help
testbench-defect-service --help
# Help for a specific command
testbench-defect-service start --help
testbench-defect-service configure --help