https://github.com/Eldara-Tech/swarmcli
A terminal UI for Docker Swarm that makes cluster state easier to see, understand, and reason about.
https://github.com/Eldara-Tech/swarmcli
cli devops docker docker-swarm golang tui
Last synced: 2 days ago
JSON representation
A terminal UI for Docker Swarm that makes cluster state easier to see, understand, and reason about.
- Host: GitHub
- URL: https://github.com/Eldara-Tech/swarmcli
- Owner: Eldara-Tech
- License: apache-2.0
- Created: 2025-05-02T14:17:04.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-04-02T06:26:14.000Z (4 days ago)
- Last Synced: 2026-04-02T20:10:10.773Z (4 days ago)
- Topics: cli, devops, docker, docker-swarm, golang, tui
- Language: Go
- Homepage: https://swarmcli.io/
- Size: 5.95 MB
- Stars: 12
- Watchers: 2
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Notice: NOTICE
Awesome Lists containing this project
- fucking-awesome-docker - swarmcli - Swarm Management at the speed of thought — with real-time log streaming, instant shell access to containers, seamless port forwarding, and on-demand secret reveal capabilities, giving you full control over your Docker Swarm without breaking your flow. (Container Operations / User Interface)
- awesome-docker - swarmcli - Swarm Management at the speed of thought — with real-time log streaming, instant shell access to containers, seamless port forwarding, and on-demand secret reveal capabilities, giving you full control over your Docker Swarm without breaking your flow. (Container Operations / User Interface)
README
Swarm Management at the Speed of Thought
The terminal-UI for Docker Swarm you’ve been waiting for. Fast, keyboard-driven, and open source.
Why SwarmCLI? •
Quickstart •
Features •
Installation •
Contributing •
Homepage
---
## Visual Feast
## Why SwarmCLI?
In the Kubernetes world, **k9s** is the gold standard for cluster management. We believe Docker Swarm users deserve the same level of quality, speed, and intuition.
**"Because Swarm is not dead, it's just efficient. And it deserves better tools."**
SwarmCLI translates the complexity of Docker Swarm into a sleek, keyboard-centric terminal UI. It’s built for developers who want to manage their clusters without leaving the terminal or waiting for heavy Web UIs to load.
## Quickstart
Get up and running in seconds:
```bash
# macOS/Linux via Homebrew
brew tap eldara-tech/tap
brew install swarmcli
# Run it
swarmcli
```
## Features
- **Real-time Observability**: Live monitoring of Services, Tasks, Nodes, and Containers.
- **Stack Awareness**: Navigate your cluster hierarchically (Stacks > Services > Tasks).
- **Instant Logs**: No more `docker service logs -f`. Just press `l` on any service.
- **Secrets & Configs**: Manage, rotate, and — with Pro — **reveal** secrets for debugging.
- **Management Actions**: Scale, restart, remove, and update services with single keystrokes.
- **Zero Config**: Works out-of-the-box with your local Docker engine or remote via SSH/Contexts.
- **Lightweight**: Built with Go. Single static binary (< 20MB). Zero dependencies.
## Installation
### Build from Source
```bash
git clone https://github.com/Eldara-Tech/swarmcli.git
cd swarmcli
go install
```
## Using Docker container to build and run locally
```
docker build -t swarmcli-dev .
docker run --rm -it -v "$PWD":/app -v /var/run/docker.sock:/var/run/docker.sock -w /app swarmcli-dev
```
or with docker compose:
```
docker compose run --build --rm swarmcli
```
Then run:
```
go run .
```
## Logging
```bash
# Production (default)
$ go run .
# → writes JSON logs to ~/.local/state/swarmcli/app.log
# Development
$ SWARMCLI_ENV=dev go run .
# → writes pretty logs to ~/.local/state/swarmcli/app-debug.log
# Optional: control verbosity
$ LOG_LEVEL=debug SWARMCLI_ENV=dev go run .
```
### Environment variables
- `SWARMCLI_ENV`: `dev` enables pretty debug logs (default is `prod`).
- `LOG_LEVEL`: `debug`, `info`, `warn`, `error`, …
- `SWARMCLI_DISABLE_VERSION_CHECK=true`: disables the startup request to `https://swarmcli.io/api/v1/version` that checks whether a newer release is available.
On startup, SwarmCLI checks for a newer release by sending the current version and edition to `https://swarmcli.io/api/v1/version`. Set `SWARMCLI_DISABLE_VERSION_CHECK=true` to opt out.
Colorize log tails. Not perfect but simple:
```bash
sudo apt install ccze
tail -f ~/.local/state/swarmcli/app-debug.log | ccze -A
```
### Integration tests
The logs for the integration tests can be enabled with:
```bash
TEST_LOG=1 ./test-setup/testenv.sh test
```
## Key Bindings
| Key | Action |
| :------- | :---------------------- |
| `?` | Show Help / Cheat Sheet |
| `:stack` | Navigate to Stacks |
| `:svc` | Navigate to Services |
| `:node` | Navigate to Nodes |
| `:config` | Navigate to Config |
| `:secret` | Navigate to Secret |
| `:node` | Navigate to Nodes |
| `l` | View Logs |
| `s` | Scale Service |
| `r` | Restart Service |
| `ctrl-c` | Quit |
## Project Hygiene
Impeccable project hygiene is the backbone of a thriving ecosystem.
- **[Contributing](CONTRIBUTING.md)**: We ❤️ contributions! Check our guide to get started.
- **[Security](SECURITY.md)**: Found a bug? Let us know securely.
- **[Code of Conduct](CODE_OF_CONDUCT.md)**: Expectations for our community.
- **[License](LICENSE)**: Apache 2.0.
## Releasing
Releases are fully automated — **no manual version file to update**. The git tag is the single source of truth.
```bash
git tag v1.5.0
git push origin v1.5.0
```
Pushing a `v*` tag triggers the [release workflow](.github/workflows/release.yml) which:
1. Injects the tag into the binary via GoReleaser ldflags (`-X main.version=1.5.0`)
2. Builds for Linux, macOS, Windows, and FreeBSD (multiple architectures)
3. Publishes a GitHub release with auto-generated changelog
4. Pushes multi-arch Docker images to Docker Hub
5. Updates the [Homebrew tap](https://github.com/Eldara-Tech/homebrew-tap) and [Scoop bucket](https://github.com/Eldara-Tech/scoop-bucket)
The in-app `Version:` header reads from the injected value. Local builds without GoReleaser show `dev`.
---
Built by the community for the community. Made with ❤️ for the Docker Swarm community.