CLI Commands¶
In addition to the interactive dashboard, Sidekick Docker provides eight non-interactive subcommands for scripting and quick lookups: ps, logs, images, volumes, networks, stats, df and inspect.
sidekick-docker (no arguments)¶
Launches the interactive TUI dashboard. See Dashboard Overview.
sidekick-docker ps¶
List containers in a table format.
# Running containers only (default)
sidekick-docker ps
# All containers (including stopped)
sidekick-docker ps --all
# Machine-readable JSON
sidekick-docker ps --format json
# Container IDs only (overrides --format)
sidekick-docker ps -q
| Flag | Description |
|---|---|
-a, --all |
Show all containers (default: running only) |
--format <table\|json> |
Output format (default: table) |
-q, --quiet |
Only print container IDs |
sidekick-docker logs¶
Stream logs from a container.
# Follows when attached to a terminal; prints and exits when piped
sidekick-docker logs <container>
# Explicitly follow / don't follow
sidekick-docker logs <container> --follow
sidekick-docker logs <container> --no-follow
# Last 50 lines (default: 100)
sidekick-docker logs <container> --tail 50
| Flag | Description |
|---|---|
-f, --follow |
Follow log output (default when attached to a terminal) |
--no-follow |
Print logs and exit |
-n, --tail <lines> |
Number of lines to show from the end (default: 100) |
sidekick-docker images¶
Lists local images.
sidekick-docker images # table
sidekick-docker images --all # include intermediate layers
sidekick-docker images -q # IDs only, for piping
sidekick-docker images --format json
sidekick-docker volumes¶
Lists named volumes, including which containers currently mount each one.
sidekick-docker networks¶
Lists networks with their subnet and attached-container count.
sidekick-docker stats¶
One-shot resource usage for every running container, like
docker stats --no-stream. It samples and exits rather than streaming, so it
composes in scripts and pipelines.
sidekick-docker df¶
Aggregate disk usage, equivalent to docker system df. This is the only place
build cache is reported, and it is frequently the largest consumer.
sidekick-docker inspect¶
Prints the raw inspect payload for a container as JSON — everything the dashboard's Config tab summarises (mounts, restart policy, health history, exit status) plus what it leaves out, such as resource limits. Accepts a name, a full ID, or an ID prefix.
Exits non-zero when no container matches.
Global Options¶
| Flag | Description |
|---|---|
--socket <endpoint> |
Docker endpoint: socket path, unix:// or tcp://host[:port] URL (see Docker Socket) |
--no-color |
Disable colored output (the NO_COLOR env var also disables it; FORCE_COLOR forces it on) |
--verbose |
Show full error details |
--shell <path> |
Shell for Exec in the dashboard (default: $SIDEKICK_DOCKER_SHELL, else /bin/sh) |
--version |
Show version |
--help |
Show help |
NO_COLOR and --no-color turn the interactive dashboard monochrome as well as the command output.
Environment Variables¶
| Variable | Description |
|---|---|
DOCKER_HOST |
Docker endpoint used when --socket is not given (unix://, tcp://, ssh://) |
SIDEKICK_DOCKER_SHELL |
Shell for dashboard Exec when --shell is not given (default /bin/sh) |
NO_COLOR / FORCE_COLOR |
Disable / force colored output |