Why devstack?

Setting up local dev infrastructure shouldn't be a bottleneck. devstack gives you an opinionated, batteries-included workflow that takes you from zero to a fully running development stack in seconds.

• Instant Infrastructure — Spin up production-grade services with a single command
• Zero Configuration Overhead — Sensible defaults that just work, fully customizable when you need it
• Docker-Native — Leverages Docker Compose for reliable, reproducible environments
• Declarative Config — Your entire stack defined in one devstack.config.json, shareable across your team
• Pluggable Architecture — Add services incrementally as your project evolves

Installation

npm install -g @palr-dev/devstack-cli

Prerequisites: Node.js >= 18 and Docker must be installed and running.

Quick Start

Get a PostgreSQL database running in under 30 seconds:

# Initialize your devstack project
devstack init my-project

# Add a PostgreSQL service
devstack add postgres

# Generate the Docker Compose configuration
devstack gen

# Launch your stack
devstack up

Your PostgreSQL database is now live at localhost:5432 and ready for connections.

Commands

| Command | Description | |---|---| | devstack init [name] | Initialize a new devstack project | | devstack add postgres | Add a PostgreSQL service to your stack | | devstack gen | Generate a Docker Compose file from your config | | devstack up | Start all configured services | | devstack down | Stop all running services |

Adding PostgreSQL

devstack add postgres --port 5433 --user admin --password secret --database mydb

| Flag | Description | Default | |---|---|---| | -p, --port <port> | Port to expose PostgreSQL on | 5432 | | -u, --user <user> | PostgreSQL username | postgres | | -P, --password <password> | PostgreSQL password | postgres | | -d, --database <database> | Database name | postgres |

Starting & Stopping

devstack up             # Start services
devstack up --build     # Rebuild images before starting

devstack down           # Stop services
devstack down -v        # Stop and remove volumes
devstack down -i        # Stop and remove images
devstack down -a        # Stop and remove everything

Configuration

Everything lives in a single devstack.config.json:

{
  "projectName": "my-project",
  "version": "1.0.0",
  "composeFileName": "docker-compose.devstack.yml",
  "services": {
    "postgres": {
      "enabled": true,
      "image": "postgres:latest",
      "containerName": "my-project_postgres",
      "port": "5432",
      "username": "postgres",
      "password": "postgres",
      "database": "postgres",
      "volume": true
    }
  }
}

Commit this file to version control and every team member gets an identical stack.

Roadmap

• Redis — In-memory data store
• MongoDB — Document database
• MySQL / MariaDB — Relational database alternatives
• RabbitMQ — Message broker
• Real-time log streaming
• Service health checks
• Status dashboard
• Secrets management via .env

Contributing

Contributions are welcome! See the GitHub repository for development setup and contribution guidelines.

License

MIT