# Wiremap

See your Docker containers and Kubernetes clusters as a live map — in your browser, from a single binary.

[![CI](https://github.com/codeofmario/wiremap/actions/workflows/ci.yml/badge.svg)](https://github.com/codeofmario/wiremap/actions/workflows/ci.yml)
[![Release](https://img.shields.io/github/v/release/codeofmario/wiremap)](https://github.com/codeofmario/wiremap/releases/latest)
[![Docker Pulls](https://img.shields.io/docker/pulls/codeofmario/wiremap)](https://hub.docker.com/r/codeofmario/wiremap)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
![Go](https://img.shields.io/badge/Go-1.25+-00ADD8?logo=go&logoColor=white)
![React](https://img.shields.io/badge/React-19-61DAFB?logo=react&logoColor=white)

<p align="center">
  <img src="docs/assets/demo.gif" alt="Demo: from the cluster overview into the shop namespace, then a Deployment, its Pods and a Pod's live logs — all with the keyboard" width="900" />
</p>

## Why Wiremap?

- **One binary, nothing to install in your cluster.** No agents, no sidecars, no database. Point it at a Docker socket or a kubeconfig and open your browser.
- **Docker and Kubernetes in one place.** Local containers, remote Docker hosts over TCP, TLS or SSH, and as many Kubernetes clusters as you like, one click apart.
- **A map, not a list.** See which containers share a network, which Pods sit behind a Service, what runs on each Node — and drill down with a double-click.
- **Live.** The map, logs and metrics update as things change. No refresh button.
- **Act where you look.** Logs, shell, files, YAML, scale, restart, cordon and drain — right from the side panel.
- **Only what you're allowed.** Wiremap uses your kubeconfig's permissions, so a read-only user gets a read-only map.

## Install

```bash
curl -sSL https://raw.githubusercontent.com/codeofmario/wiremap/main/install.sh | sh
wiremap
```

Then open [http://localhost:7070](http://localhost:7070).

<details>
<summary>Other ways to install</summary>

**Docker**

```bash
docker run -d -p 7070:7070 \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  codeofmario/wiremap
```

**Docker Compose**

```yaml
services:
  wiremap:
    image: codeofmario/wiremap
    ports: ["7070:7070"]
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
    restart: unless-stopped
```

**From source**

```bash
git clone https://github.com/codeofmario/wiremap.git
cd wiremap && make build && ./bin/wiremap
```
</details>

## Docker

<p align="center">
  <img src="docs/assets/screenshot-docker.png" alt="Docker view: containers grouped by network, with a container's live logs in the side panel" width="900" />
  <br /><em>Docker — containers grouped by network</em>
</p>

Wiremap connects to your local Docker automatically. For each container you can:

- see it on a map, grouped by network
- follow its logs and CPU, memory and network usage
- open a shell in it
- browse and edit its files
- view and change its environment variables, ports, volumes and labels

To connect to more Docker hosts (TCP, TLS or SSH):

```bash
wiremap --host unix:///var/run/docker.sock --host tcp://prod:2375
```

## Kubernetes

<p align="center">
  <img src="docs/assets/screenshot-k8s.png" alt="Kubernetes view: sidebar of resource kinds with counts, a Service and its pods on the map, pod logs in the side panel" width="900" />
  <br /><em>Kubernetes — a Service and its pods, with live logs</em>
</p>

Give Wiremap a kubeconfig, then pick the cluster in the top bar:

```bash
wiremap --kubeconfig ~/.kube/config                  # current context
wiremap --kube-context prod --kube-context staging   # several contexts
```

**How to move around**

- **Sidebar** — pick what to show: a namespace overview, Nodes, Pods, Deployments, Services, ConfigMaps and every other kind, including custom resources. Each shows how many there are.
- **Double-click** (or `Enter`) to open something and see what's inside it:
  - Namespace → everything in it
  - Deployment, StatefulSet, DaemonSet, Job → its Pods
  - CronJob → its Jobs
  - Service → its Pods
  - Node → the Pods running on it
  - ConfigMap, Secret, volume claim → the Pods using it
  - Pod → its containers
  - Container → its logs
- **Click** anything to open the side panel: logs, metrics, shell, YAML and events.
- **Go back** with `Esc` or the breadcrumb at the top. The page URL always matches what you see, so you can share it.

From the side panel you can also edit YAML, scale, restart, delete, run a CronJob now, and cordon or drain a node.

**Keyboard shortcuts**

| Key | What it does |
|-----|--------------|
| `:` | Jump to a kind, e.g. `:pods`, `:deploy`, `:svc`, `:nodes`. Add a namespace to switch too: `:deploy kube-system`, or `all` |
| `/` | Filter by name |
| `↑` `↓` or `j` `k` | Select the next / previous item |
| `Enter` | Open the selected item |
| `Esc` | Close the side panel, then go back |
| `l` `s` `y` `d` | Logs, shell, YAML, details of the selected item |

Wiremap can only do what your kubeconfig user is allowed to do. To give it read-only access, see [permissions](docs/configuration.md#permissions).

### Try it on a local cluster

This creates a small 3-node cluster with [kind](https://kind.sigs.k8s.io) and a demo `shop` app to explore:

```bash
kind create cluster --config examples/kubernetes/kind.yaml
kubectl apply -f examples/kubernetes/demo-app.yaml
kubectl wait --for=condition=Established crd/featureflags.demo.wiremap.io
kubectl apply -f examples/kubernetes/demo-flags.yaml
wiremap --kube-context kind-wiremap-demo
```

When you're done: `kind delete cluster --name wiremap-demo`.

## Configuration

Everything can be set with flags or a `wiremap.yml` file — Docker hosts, TLS, SSH, Kubernetes clusters and the port. See [docs/configuration.md](docs/configuration.md).

## Docs

- [Configuration](docs/configuration.md) — Docker hosts, Kubernetes clusters, permissions, flags
- [API](docs/api.md) — REST and WebSocket reference
- [Development](docs/development.md) — build, test and contribute
- [Contributing](CONTRIBUTING.md) — report bugs, suggest features, open a pull request

## License

[MIT](LICENSE)