Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Sidekick Docker CLI

npm npm Downloads License: MIT Ask DeepWiki

A terminal dashboard for Docker. Manage containers, Compose projects, images, volumes, and networks — all from a single, keyboard-driven TUI.

Sidekick Docker CLI Demo

Install

npm install -g sidekick-docker

Prerequisites: Node.js >= 20, Docker running.

Usage

# Launch the interactive dashboard
sidekick-docker

# List containers (non-interactive)
sidekick-docker ps
sidekick-docker ps --all

# Stream container logs
sidekick-docker logs <container>
sidekick-docker logs <container> --tail 50

Options

Flag Description
--socket <path> Custom Docker socket path
--version Show version
--help Show help

Dashboard

The dashboard has 5 panels, each mapped to a number key:

# Panel Shows Detail Tabs
1 Containers All containers with state, image, ports, uptime Logs, Stats, Env, Config, Files, Patterns
2 Services Compose projects and their services Info, Logs
3 Images Local images with tags, size, age Info, Layers
4 Volumes Named volumes with driver, mount path, usage status Info
5 Networks Docker networks with driver, scope, connected containers Info

Keybindings

Navigation

Key Action
j / Down Move down
k / Up Move up
g Jump to top
G Jump to bottom
Tab Toggle focus between side list and detail pane
Enter Focus detail pane
Esc Back to side list / close overlay / clear filter
h / Left Back to side list (when in detail pane)

Panels & Tabs

Key Action
1-5 Switch to panel
[ / ] Cycle detail tab left / right

Actions

Key Action
x Open context menu (actions for selected item)
f Open log filter (when on Logs tab)
/ Open filter
m Pin/unpin item for log comparison (Containers/Services)
J / K Scroll compare pane (when in detail focus)
z Toggle expanded layout
? Show help overlay
V Show version
q / Ctrl+C Quit

Container Actions (via context menu)

Key Action
s Start
S Stop
r Restart
R Remove (with confirmation)
e Exec into container
c Copy logs to clipboard

Compose Actions (via context menu)

Key Action
u Up (start project)
d Down (stop project)
r Restart
S Stop
c Copy logs to clipboard

Features

  • Real-time log streaming — follows container logs with token-level syntax highlighting (HTTP methods, status codes, URLs, IPs, timestamps, JSON keys)
  • Dual-log compare — pin a second container or service with m to view both log streams side by side
  • Log search & filter — press f on the Logs tab to search within log output with exact or fuzzy matching and match highlighting
  • Log analytics — severity count badges, severity sparkline over time, and pattern clustering that groups similar logs into templates with <*> wildcards
  • Live stats with sparklines — CPU, memory, network I/O, block I/O, and log severity charted as inline sparklines (60-sample history)
  • Filesystem inspector — view all filesystem changes inside containers (added/changed/deleted files)
  • Image layer explorer — inspect image layer history with sizes and Dockerfile instructions
  • Interactive exec — open a shell inside any running container
  • Compose detection — automatically discovers projects from container labels, merges with compose file config
  • Filter — press / to filter any list by name
  • Confirmation modals — destructive actions always ask before executing
  • Mouse support — click items to select, scroll to navigate
  • Toast notifications — non-blocking feedback for actions

Configuration

Custom Docker Socket

sidekick-docker --socket /var/run/docker.sock
sidekick-docker --socket tcp://192.168.1.100:2375

Documentation

Full documentation is available at the docs site.

See Also

Sidekick Agent Hub — Multi-provider AI coding agent monitor. Real-time visibility into Claude Code, OpenCode, and Codex CLI sessions with token tracking, context management, and session intelligence. Available as a TUI on npm and a VS Code extension.

Contributing

Contributions are welcome! See CONTRIBUTING.md for setup instructions and guidelines.

License

MIT