Stacker

Simple Application Environments

Stacker is a simple tool for defining application environments, aka stacks. Each stack is optimized for development and for production use as well. Stacker is built on top of Docker and Docker Compose as an abstraction layer. The main paradigm followed in designing Stacker was convention over configuration.

🏁 Instalation

Install the CLI app globally using NPM.

# install stacker
npm install -g stacker-cli

# make sure it's working
stacker --version

🔥 Getting Started

Before going further, make sure you cd into the root path of your project (cd ~/Projects/test-project).

1. Generate the stacker.yaml file

$ stacker init

If your project already has a stacker.yaml file, this step is not required.

2. Setup the project on your local machine

$ stacker link

This will do several things

• create a local IP alias (eg. 127.20.17.1)
• setup your chosen domain name in /etc/hosts
• add the project to the projects list

3. Build and start your application

$ stacker up

After this you will be able to reach your application using the domain name you choose previously. (eg. test-project.dev)

📖 Commands

Here are the sub-commands for stacker CLI.

$ stacker init

Generates stacker.yaml based on your responses.

Type	Name	Description	Required
argument	[stack]	Stack name	no
option	`-y	--defaults`	Use default options

$ stacker link

• creates a local IP alias (eg. 127.20.17.1)
• adds your chosen domain name in /etc/hosts
• adds the project to the projects list

$ stacker unlink

Does the opposite of stacker link.

$ stacker up

Builds and starts the project.

Type	Name	Description	Required
option	--ip	IP address	no
option	--detached (-d)	Detached mode	no

$ stacker build

Builds the project.

Type	Name	Description	Required
option	--ip	IP address	no

$ stacker start

Starts the application.

$ stacker stop

Stops the application.

$ stacker restart

Restarts the application.

$ stacker down

Removes and stops the application.

$ stacker shell

Opens an interactive shell for a given service.

Type	Name	Description	Required
argument	[service]	Service name	no

$ stacker run

Executes a pre-defined shell command.

Type	Name	Description	Required
argument	[command]	Runnable name	no

$ stacker eject

Ejects a config file so you'll be able to customize it.

Type	Name	Description	Required
argument	[file]	Ejectable name	no

$ stacker links

Displays all the linked projects.

📜 License

MIT @ Stacker