dkr

command module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 5, 2020 License: MIT Imports: 8 Imported by: 0

README

Go Report Card Maintainability GitHub last commit GitHub release

Light CLI application to make it easier for developers to interact with docker containers.

It can be utilisied while working regularly with containers as a developer. Provides a nice CLI user interface to do basics.

Table of contents

How to use

dkr is a really simple CLI application to help you with your everyday tasks around docker containers.
It is written in Go to ensure proper distribution for the main developer platforms.

It does not try to be an all-around solution for providing CLI interface over docker functions. The reason for this is that there are a lot of docker commands that do not need any simplification because they are not used regularly or just plain simple to use. Consider this application as a shortcut for doing something that you can do anyway but takes longer time. In the long run the plan is to eliminate use cases that are pretty similiar to the current functionality.

On select screens you can use your arrow keys and enter to navigate however this is also stated everytime you encounter a select situation.

dkr implements 3 commands right now:

  • exec - For times when you have to enter the container and manually check things
  • logs - When you want to see the logs of the container
  • stop - To stop the container

The reason for having this 3 is that in my experience most of the time when I use docker ps I want to do one of these commands. As a common user I think an interactive version is better.

Two potential way to use the application:

  • dkr
    • This will lead you to the list of containers where you can select the container and action
  • dkr logs / dkr exec / dkr stop
    • Takes you to the list of containers where you can choose which one should be the target of the given action command

Install

Docker has to be installed beforehand

  • Manual installation
    • clone the repository under github.com/Roverr/dkr
    • dep ensure (install dep before)
    • go build . (install go before)
    • Move the binary into your path
  • Choose a binary packed under the latest release
  • Use the following scripts below
Linux
mkdir -p /tmp/dkr && \
curl -o /tmp/dkr/dkr.tar.gz -sSL https://github.com/Roverr/dkr/releases/download/v1.0.0/dkr.linux.amd64.tar.gz && \
tar -xzvf /tmp/dkr/dkr.tar.gz -C /tmp/dkr && \
mv /tmp/dkr/dist/linux/dkr /usr/local/bin/dkr && \
chmod +x /usr/local/bin/dkr && \
rm -rf /tmp/dkr
OSx
brew tap roverr/opensource
brew install dkr

Improvements

Have a use case similiar to what this application is made for?
Open an issue describing it!

Credits

Big thanks to MariaLetta for the Gopher in the headline!

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL