supdock 3.5.1

What's Up, Doc(ker)? A slightly more visual way to interact with the docker daemon
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

# Supdock

[![crates.io](https://img.shields.io/crates/v/supdock.svg)](https://crates.io/crates/supdock)
[![npm](https://img.shields.io/npm/v/supdock)](https://www.npmjs.com/package/supdock)
![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/segersniels/supdock/ci.yml)

What's Up, Doc(ker)? A convenient way to interact with the docker daemon. Supdock is a wrapper for the docker command meaning you can still use all of the other `docker` commands without issues.

<p align="center" />
<img src="https://i.imgur.com/ATV0nP7.png" width="250" />

## Why

Repetitive use of `docker ps`, `docker logs`, `docker stats` and `docker exec -ti` when troubleshooting complex container setups can get chaotic. Supdock aims to optimize and speed up your workflow using docker.

![img](./demo.gif)

## Installation

### Cargo

```bash
cargo install supdock
```

### NPM

```bash
npm install -g supdock
```

Chances are you will run into issues with `yarn` due to symlink issues, so install through npm instead.

### Binary

Grab a binary from the [releases](https://github.com/segersniels/supdock/releases) page and move it into your desired bin (eg. /usr/local/bin) location.

```bash
mv supdock-<os> /usr/local/bin/supdock
chmod +x /usr/local/bin/supdock
```

## Alias

If you don't want to use `supdock` and `docker` separately you can just set an alias.

```bash
alias docker="supdock"
```

## Usage

```bash
What's Up Doc(ker)?

Usage: supdock [COMMAND]

Commands:
  prune  Remove stopped containers and dangling images. For more detailed usage refer to "docker system prune -h"
  ssh    SSH into a container
  env    See the environment variables of a running container
  cat    Echo the contents of a file using cat on a container

Options:
  -h, --help  Print help

For more detailed usage on docker refer to "docker help"
```

Usage above can differ from the actual usage shown by the command.

## Changelog

For a basic changelog overview go [here](./CHANGELOG.md).
I try to keep track of most general changes as best as I can.

## Contributing & Troubleshooting

If you would like to see something added or you want to add something yourself feel free to create an issue or a pull request.
Please provide either the panic log or your terminal output with `RUST_LOG=debug` enabled for easier troubleshooting.