Commands
All commands are run via Task. Run task with no arguments to see the full list, or task --summary <command> for detailed help on a specific command.
Core commands
| Command | Description |
|---|---|
task init |
Interactive setup wizard — choose environment, create .env, register global Taskfile |
task start |
Start all services for the current environment |
task stop |
Stop all services (volumes are preserved) |
task restart |
Stop then start all services |
task logs |
Tail combined log output for all services (Ctrl+C to stop) |
task status |
Show running services with their status and URLs |
task doctor |
Run health checks and report issues with suggested fixes |
Project integration
| Command | Description |
|---|---|
task add name=<name> port=<port> |
Generate a docker-compose snippet for connecting a project |
The add command also accepts an optional group parameter for the dashboard category:
task add name=myapp port=3000 group="Frontend"
After running task init, you can use the global shorthand from any directory:
task -g claritools:add name=myapp port=3000
Documentation
| Command | Description |
|---|---|
task docs-build |
Build the documentation site into site/ using Docker |
task docs-serve |
Start a live-reload preview server on http://localhost:8000 |
The built docs are served by a Caddy container at https://docs.<domain>.ciservers.net when the stack is running. Run task docs-build before task start (or restart) to ensure the docs are up to date.
Certificate management
| Command | Description |
|---|---|
task generate-local-self-signed-certs |
Generate a self-signed wildcard cert for *.local.ciservers.net |
Only needed for local and dev environments. CD mode uses Let's Encrypt.
Remote access
| Command | Description |
|---|---|
task ssh-docker |
Open a shell inside the Traefik container |
task ssh-docker-<name> |
Open a shell inside a container by name (e.g., task ssh-docker-prometheus) |
task ssh-cd |
SSH into the multi-dev server (nirn.clarity-innovations.com) |
task ssh-multidev |
Alias for ssh-cd |
Doctor checks
task doctor verifies the following for all environments:
.envfile existsCLARITOOLS_ENVIRONMENTis set- Docker daemon is running
autoproxynetwork exists- Traefik container is running
Additional checks by environment:
| Check | Local | Dev | CD |
|---|---|---|---|
| Self-signed certs exist and not expired | Yes | Yes | No |
| Keycloak is running | No | Yes | No |
| oauth2-proxy is running | No | Yes | No |