Command line tool to generate dockerfile definitions and scaffold project templates for CI/CD operations.

Motivation 🔥

Upon creating Docker projects and modules, I observed a recurring pattern in the necessary files and considered streamlining it with a cli tool. Typically, to dockerize a project the directory must contain the following:

• The src folder containing the code.
• The Dockefile for building the docker image.
• (Optionally) The config file for runtime configuration.
• (Optionally) The .env file for setting environmental variables.
• (Optionally) The docker-compose.yaml for creating a Docker service stack.

Dockerforge intends to automate the creation of these files while also providing scaffolded templates for the various programming languages. This can help you shorten the time it takes to go from idea to development to production and reduce the time required to dockerize your application.

Installation ⚡

Using

To install tool, execute the following command:

npm install -g dockerforged

Using binary

Head over to the releases pages and download the appropriate release for your OS:

./dockerforge

Usage 🚀

The tool generates docker definitions ( Dockerfile, docker-compose.yaml, docker-compose.production.yaml ) for the selected programming language in the current directory. This definitions include a structure for building the docker image of your application using two phases, development and production. When the docker-compose.yaml file is used to create a docker service then the development phase of the docker image is utilized allowing for hot-reload of your code inside the container. When the docker-compose.production.yaml file is invoked, then the corresponding production phase of the docker image is used. Once installed, you can use the tool interactively or with cli options by executing the dockeforge command:

The tool can also scaffold a template project, creating an src directory for your project and the accompanying package manager for the selected language. After running the command shown above the project directory has the following structure:

Programming Languages 📚

The tool supports docker definitions and scaffolded templates ( src, language package managers ) for the following programming languages:

• NodeJS with package.json
• Typescript with package.json and tsconfig.json
• Python with requirements.txt
• Golang with go.mod
• Rust with Cargo.toml

CLI Options ⚙️

The tool is interactive, but it can also be used with cli options, which are the following:

$ dockerforge -h

Usage: dockerforge [options]

🐳 Dockerfile generator cli tool for CD/CI operations.

Options:
  -n,--name <string>      Target project name
  -e,--env                Create project .env file
  -m,--makefile           Create project Makefile
  -s,--scaffold           Scaffold template project with 'src' structure
  -c,--config <string>    Create project config file (choices: "json", "toml", "yaml", "ini", "none")
  -l,--language <string>  Target project language (choices: "typescript", "javascript", "python", "golang", "rust")
  -v, --version           Output the current version
  -h,--help               Display this help message

-n, --name <string>

• This option sets the name of the target project, this will be used in the generated dockerfile definitions. By default it set to the current working directory.

-e, --env

• This option creates an empty .env inside the current working directory.

-m, --makefile

• This option creates a Makefile with docker command shortcuts for development & building inside the current working directory. These command shortcuts are listed below.
• Makefile: Use make <command> to run this shortcuts in the cli:
  • start: Command shortcut for docker-compose up -d
  • stop: Command shortcut for docker-compose down -v
  • build: Command shortcut for docker build -t project-app .
  • remove: Command shortcut for docker image rm project-app
  • update: Command shortcut for running the stop, remove and start shortcuts sequentially.
  • production: Command shortcut for docker-compose -f docker-compose.yaml -f docker-compose.production.yaml up -d. Basicaly uses compose file along with the production compose file.
  • run: Command shortcut for running the code in the src folder.

-s, --scaffold

• This option scaffold a project template for the selected programming language. If an src file already exists in the current working directory, this option will have no effect.

-c, --config <string>

• This option creates a configuration file of the chosen extension inside the current working directory. If a config file with the same file extention exists in the current working directory, this option will have no effect.

-l, --language <string>

• This option sets the target programming language of the project.

-v, --version

• This option outputs the currect version of the tool.

-h, --help

• This option outputs the help message shown in the previous section.