Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dgrbrady/nvim-docker

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/dgrbrady/nvim-docker
Owner: dgrbrady
License: mit
Created: 2022-07-20T18:03:17.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-01-22T22:43:00.000Z (about 1 year ago)
Last Synced: 2024-08-02T13:33:30.621Z (7 months ago)
Language: Lua
Size: 53.7 KB
Stars: 118
Watchers: 10
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # nvim-docker

Docker management right inside Neovim!

## Features

![Screenshare - 2022-07-20 5_59_58 PM (1)](https://user-images.githubusercontent.com/38011308/180091781-a23adf85-a159-4caa-b2a9-4abe021a1ff4.gif)

- Container management

  - View containers on your local machine with live reloading

  - Bring containers up/down

  - Remove and rebuild containers

  - Send commands to containers (Soon^TM)

  - View container logs

- Configurable (Soon^TM)

- Docker compose integration (Soon^TM)

- Image management

  - View images on you local machine with live reloading (Soon^TM)

  - Create new containers from images (Soon^TM)

  

## Installation

### Packer

```lua

use {

  'dgrbrady/nvim-docker',

  requires = {'nvim-lua/plenary.nvim', 'MunifTanjim/nui.nvim'},

  rocks = '4O4/reactivex' -- ReactiveX Lua implementation

}

```

## How to use

In your lua config:  

```lua

  local nvim_docker = require('nvim-docker')

  -- list containers

  nvim_docker.containers.list_containers()

  -- OR

  -- setting up keybindings since the `list_containers` fn does not have a default binding

  vim.keymap.set('n', 'C', nvim_docker.containers.list_containers)

```

### Default Keymaps

| Binding | Where | Effect |

| ------- | ----- | ------ |

| `j`     | Top popup | Move cursor down on container list |

| `k`     | Top popup | Move cursor up on container list |

| `l`     | Top popup | Expand container details |

| `L`     | Top popup | Expand all containers |

| `h`     | Top popup | Collapse container details |

| `H`     | Top popup | Collapse all containers |

| `r`     | Top popup | Restart container |

| `dd`    | Top popup | Deletes container (asks for confirmation) |

| `t`     | Top popup | View container logs |

| `` | Top popup | Focus bottom popup |

| `t`     | Bottom popup | Toggles whether the cursor should be stuck to the bottom of the popup. Helpful if you want to watch the latest logs as they come in |

| `` | Bottom popup | Focus top popup |

## Roadmap

- [ ] Interact with containers

  - [x] Start container [12c8e6](https://github.com/dgrbrady/nvim-docker/commit/12c8e625a7f3864f89e11f0d24297a5ce1f09542)

  - [x] Stop container [12c8e6](https://github.com/dgrbrady/nvim-docker/commit/12c8e625a7f3864f89e11f0d24297a5ce1f09542)

  - [x] Restart container [39a1be](https://github.com/dgrbrady/nvim-docker/commit/39a1be419e7b6817bd9dd5474c1a2dd80790934b)

  - [x] Delete container [98b561](https://github.com/dgrbrady/nvim-docker/commit/98b5611fd81aca130f13d2bd319fa49a7a2f8ee5)

  - [x] View logs from container [c71005](https://github.com/dgrbrady/nvim-docker/commit/c71005aba5cc70fea33338cdcb50620e4fe2de8f)

  - [ ] Run command in container

- [ ] Interact with images

  - [ ] List image

  - [ ] Delete image

  - [ ] Create container from image

- [ ] Docker compose integration

- [ ] Provide options for user configuration

- [ ] Documentation

- [ ] Telescope integration?

## Development

* clone the project `git clone https://github.com/dgrbrady/nvim-docker`

* go to the project folder `cd nvim-docker`

* start editing `nvim --cmd "set rtp+=."`

* reference the dev configurations `:luafile dev/init.lua`

* run the `containers.list_containers()` function using `,w` keybind