CLI reference
kusaw service
Start the factory at login (systemd, launchd, or Task Scheduler)
kusaw service
Start the factory at login (systemd, launchd, or Task Scheduler)
Usage
kusaw service [flags]Flags
| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for service |
Subcommands
kusaw service env
Set, unset, or list service environment variables
kusaw service env [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for env |
Example:
kusaw service env listkusaw service env list
Print the names of variables in the service env file
kusaw service env list [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for list |
Example:
kusaw service env listkusaw service env set
Add or replace a variable in the service env file
kusaw service env set <KEY>=<VALUE> [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for set |
Example:
kusaw service env set KEY=VALUEkusaw service env unset
Remove a variable from the service env file
kusaw service env unset <KEY> [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for unset |
Example:
kusaw service env unset KEYkusaw service hold
Keep a WSL distro alive while the user unit is active
kusaw service hold [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for hold |
Example:
kusaw service holdkusaw service install
Register kusaw up to start at sign-in
kusaw service install [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--dry-run | bool | false | Print the changes without making them | |
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for install |
--linger | bool | false | Keep the Linux user service running after sign-out | |
--no-windows-task | bool | false | Skip the Windows logon task (WSL) | |
--port | int | 0 | Dashboard port (0 uses the registry ui.port) |
Example:
kusaw service installkusaw service start
Start the installed service now
kusaw service start [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for start |
Example:
kusaw service startkusaw service status
Show whether the start-at-login service is installed and healthy
kusaw service status [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for status |
--json | bool | false | Print JSON |
Example:
kusaw service statuskusaw service stop
Stop the service with a drain
kusaw service stop [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for stop |
Example:
kusaw service stopkusaw service uninstall
Remove the start-at-login service
kusaw service uninstall [flags]| Name | Short | Type | Default | Description |
|---|---|---|---|---|
--config | string | Path to kusaw.yaml (overrides KUSAW_CONFIG and parent search) | ||
--factory | string | factory name from kusaw list | ||
--help | -h | bool | false | help for uninstall |
Example:
kusaw service uninstallExit codes
| Code | Name | Description |
|---|---|---|
| 0 | ok | Success. |
| 1 | error | Runtime error. |
| 2 | usage | Usage or validation error. |
| 3 | rejected | Control request rejected; the error string is printed verbatim. |
| 4 | not picked up | Control request not picked up within the wait time while serve runs. |
Example
kusaw service status