Skip to content

Easy access to dockerignore boilerplates

License

Notifications You must be signed in to change notification settings

KeisukeYamashita/dobo

 
 

Repository files navigation

dobo: fast access to dockerignore boilerplates

CI

dobo (short for dockerignore boilerplates) is a shell script to help you easily access dockerignore boilerplates from KeisukeYamashita/dockerignore.

Typical usage

dobo dump Swift Xcode >> .dockerignore

For additional usage instructions, run dobo help.

Installation

Installation on OS X using Homebrew

$ brew install KeisukeYamashita/tap/dobo

Installation on Fedora Linux

dobo is avaiable as a COPR repository. It provides packages for main script and bash / zsh completions:

$ dnf copr enable saschpe/dobo
$ dnf install dobo dobo-bash-completion dobo-zsh-completion

Installation on other (*nix) platforms

Just download dobo and put it somewhere on your $PATH. Then:

$ chmod +x /path/to/dobo   # Make dobo executable
$ dobo update              # Initialise dobo

You can automate this with the following one-liner (assuming ~/bin is on your $PATH).

$ curl -L https://raw.github.com/KeiskeYamashita/dobo/master/dobo \
        -so ~/bin/dobo && chmod +x ~/bin/dobo && dobo update

Installation on Windows

Using scoop

The easiest way to install dobo on Windows is to use scoop, a PowerShell-based package-manager of sorts for Windows:

$ scoop update
$ scoop install dobo

A great benefit to using scoop, is that it provides an easy way to update its packages, including dobo:

$ scoop update
$ scoop update dobo

git installation

You can download the whole dobo repo directly from GitHub:

$ git clone https://github.com/KeiskeYamashita/dobo.git dobo

Then add the full dobo directory (C:\Users\<Your User>\bin\dobo) to your system's PATH environment variable.

Manual installation

To manually install only the dobo.bat file, download it to your computer and save it to any directory that is in your PATH.

Right-click this link and select 'Save target as...' (or 'Save link as...' depending on your browser) to save it to your computer.

A good directory to put the file is C:\Users\<Your User>\bin and add that directory to your system's PATH environment variable. Where ever you put it, make sure the batch file is accessible via where dobo.

Installation on Docker

Just type the following command. The dobo Docker image is distributed by GitHub Container Registry.

$ docker run --rm ghcr.io/KeiskeYamashita/dobo dump Rails > .dockerignore

Tab completion in bash, zsh and fish

bash, zsh and fish users can enjoy the deluxe dobo experience by enabling tab completion of available boilerplate names.

Sorry, there is no tab completion support in Windows.

bash instructions

Copy dobo-completion.bash into a bash_completion.d folder:

  • /etc/bash_completion.d
  • /usr/local/etc/bash_completion.d
  • ~/bash_completion.d

or copy it somewhere (e.g. ~/.dobo-completion.bash) and put the following in your .bashrc:

source ~/.dobo-completion.bash

zsh instructions

Copy dobo-completion.zsh somewhere in your $fpath. The convention for autoloaded functions used in completion is that they start with an underscore, so I suggest you rename it to _dobo.

Alternatively, you can use dobo-completion.zsh as an oh-my-zsh plugin by following these instructions.

fish instructions

Copy dobo.fish to somewhere in your $fish_complete_path.

Credits

This repository was forked from simonwhitaker/gibo and derived almost all the source codes. Thank you @simonwhitaker for working on this amazing product.

About

Easy access to dockerignore boilerplates

Topics

Resources

License

Stars

Watchers

Forks

Languages

  • Shell 64.2%
  • Batchfile 35.5%
  • Dockerfile 0.3%