Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Silex committed Sep 14, 2018
1 parent 71ae977 commit c8b0b8f
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 86 deletions.
133 changes: 47 additions & 86 deletions README.md
Expand Up @@ -3,20 +3,19 @@

# docker.el

* [Installation](#installation)
* [Quickstart](#quickstart)
* [Screenshots](#screenshots)
* [images](#images)
* [Commands](#commands)
* [docker-images](#docker-images)
* [docker-containers](#docker-containers)
* [docker-volumes](#docker-volumes)
* [docker-networks](#docker-networks)
* [docker-machines](#docker-machines)
* [Customizations](#customizations)
* [FAQ](#faq)
* [How to use docker-machine under OSX?](#how-to-use-docker-machine-under-osx)
* [Contributions](#contributions)
Emacs integration for [Docker](https://www.docker.com)!

Supports docker containers, images, volumes, networks, docker-machine and docker-compose.

## Screenshots

### List images

![Images list](screenshots/image-ls.png)

### Image run popup

![Image run popup](screenshots/image-run.png)

## Installation

Expand All @@ -32,95 +31,57 @@ Here is a example [use-package](https://github.com/jwiegley/use-package) configu

## Quickstart

Use <kbd>M-x docker</kbd>, select a resource then then mark/unmark items using the following keybindings:
Use <kbd>M-x docker</kbd>, select a resource then then mark or unmark items using the following keybindings (for more
marking possibilities, check out https://github.com/politza/tablist):

| Keymap | Description |
| Binding | Description |
|--------------------|----------------------|
| <kbd>?</kbd> | List actions |
| <kbd>l</kbd> | Configure listing |
| <kbd>m</kbd> | Mark item |
| <kbd>u</kbd> | Unmark item |
| <kbd>t</kbd> | Toggle marks |
| <kbd>U</kbd> | Unmark all |
| <kbd>s</kbd> | Sort |
| <kbd>* r</kbd> | Mark items by regexp |
| <kbd><</kbd> | Shrink column |
| <kbd>></kbd> | Enlarge column |
| <kbd>C-c C-e</kbd> | Export to csv |
| <kbd>U</kbd> | Unmark all |
| <kbd>m</kbd> | Mark item |
| <kbd>s</kbd> | Sort |
| <kbd>t</kbd> | Toggle marks |
| <kbd>u</kbd> | Unmark item |

You can press `?` on all the listing to see the available actions. Also check out https://github.com/politza/tablist
to find more about the marking possibilities.

## Screenshots

### images

![docker.el screenshot](screenshots/images.png)

## Commands

### docker-images

<kbd>M-x docker-images</kbd> lists the docker images.
After having selected some images, you can do the following actions:

- `D`: rmi
- `F`: pull
- `I`: inspect
- `P`: push
- `R`: run
- `T`: tag
* `l`: Configure listing

### docker-containers

Running <kbd>M-x docker-containers</kbd> lists the docker containers.
After having selected some containers, you can do the following actions:
Then select an action and follow the popup instructions.

* `C`: cp
* `D`: rm
* `I`: inspect
* `K`: kill
* `L`: logs
* `O`: stop
* `P`: pause/unpause
* `R`: restart
* `S`: start
* `b`: shell
* `d`: diff
* `f`: find-file
* `l`: Configure listing
* `r`: rename
## Supported commands

### docker-volumes
- docker container: cp, diff, inspect, kill, logs, pause, rename, restart, rm, start, stop, unpause
- docker image: inspect, pull, push, rm, tag
- docker network: rm
- docker volume: rm
- docker-machine: create, env, restart, rm, start, stop
- docker-compose: build, create, logs, pull, push, remove, restart, run, start, stop, up

Running <kbd>M-x docker-volumes</kbd> lists the docker volumes.
After having selected some volumes, you can do the following actions:

* `D`: rm
* `d`: dired
* `l`: Configure listing
## Customizations

### docker-networks
### Popups

Running <kbd>M-x docker-networks</kbd> lists the docker networks.
After having selected some networks, you can do the following actions:
Thanks to [magit-popup](https://github.com/magit/magit-popup), all the popups default arguments can be customized. For
example, here is how to customize the arguments for `docker-image-run-popup`:

* `D`: rm
* `l`: Configure listing
``` elisp
(setq docker-image-run-arguments '("-i" "-t" "--rm"))
```

### docker-machines
or inside a use-package declaration:

Running <kbd>M-x docker-machines</kbd> lists the docker machines.
After having selected some machines, you can do the following actions:
``` elisp
(use-package docker
:ensure t
:bind ("C-c d" . docker)
:custom (docker-image-run-arguments '("-i" "-t" "--rm")))
```

* `C`: create
* `D`: rm
* `E`: env
* `O`: stop
* `R`: restart
* `S`: start
* `l`: Configure listing
You can also customize these using <kbd>M-x customize-variable</kbd>.

## Customizations
### Others

| Variable | Description | Default |
|-----------------------------------|---------------------------------------|------------------|
Expand Down
Binary file added screenshots/image-ls.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/image-run.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed screenshots/images.png
Binary file not shown.

0 comments on commit c8b0b8f

Please sign in to comment.