Quick Start
Get up and running with StackMark in under 2 minutes.
Prerequisites
Before you begin, make sure you have:
- Node.js 18+ installed
- Docker and Docker Compose installed and running
- One or more Docker Compose projects you want to manage
Step 1: Install StackMark
Install StackMark globally using npm:
terminal
$ npm install -g @grazulex/stackmark
Step 2: Register Your First Stack
Navigate to your Docker Compose project and register it:
terminal
$ cd ~/Dev/my-project
$ stackmark add
✔ Stack "my-project" registered
Path: /home/user/Dev/my-project
Ports allocated: nginx:9003, db:9004
StackMark automatically scans your docker-compose.yml and allocates unique ports.
Step 3: Start Your Stack
Start the stack with automatic port management:
terminal
$ stackmark start
✔ Starting my-project...
✔ Stack is running
→ http://localhost:9003
Step 4: Open the Dashboard
View all your stacks in an interactive dashboard:
terminal
$ stackmark dash
🐳 StackMark Dashboard
──────────────────────────────────────
● my-project running
→ http://localhost:9003
Other: db:9004
Press q to quit