Skip to content

README.md

Latest commit

 

History

History
86 lines (61 loc) · 2.29 KB

README.md

File metadata and controls

86 lines (61 loc) · 2.29 KB
Raw

🐒 Docker Monkey (Dockey)

A macOS menu bar tool for managing local Docker-based projects. Designed for UI/UX designers and developers who want quick access to Docker commands without the terminal.

📦 Installation

App Installation

  1. Download the latest Dockey.dmg from releases
  2. Open the DMG and drag Dockey.app to /Applications
  3. Launch Dockey from Applications (or Spotlight)
  4. The app will appear in your menu bar with a 🔨 icon

First Launch: macOS may show a security warning. Go to System Preferences → Privacy & Security and click "Open Anyway".

CLI Installation (Optional)

The CLI tool dockey is bundled inside the app. To make it available in your terminal:

# Symlink the bundled CLI to /usr/local/bin
sudo ln -sf /Applications/Dockey.app/Contents/MacOS/dockey-cli /usr/local/bin/dockey

Verify installation:

dockey --help

🚀 Usage

Menu Bar App

  • Click the menu bar icon to see all projects
  • Run commands directly from the dropdown
  • Access Settings to manage projects, containers, and commands
  • Use the Test button in Settings to preview command output

CLI Commands

# Projects
dockey project add "MyProject" --root /path/to/project
dockey project list
dockey project rm "MyProject"

# Containers
dockey project container add "MyProject" "mysql" --shell bash
dockey project container list "MyProject"

# Commands
dockey project command add "MyProject" "up" --script "docker compose up -d"
dockey project command add "MyProject" "down" --script "docker compose down"
dockey project command run "MyProject" "up"

✨ Features

  • Menu bar quick access to all projects
  • Run Docker commands with one click
  • Settings page for project/container/command management
  • Test commands with live console output
  • CLI tool for terminal users
  • Project status indicators
  • Quick navigation to project domains

🔄 Updates

When you receive a new version:

  1. Download the new Dockey.dmg
  2. Quit the running app (Menu Bar → Quit Dockey)
  3. Replace the app in /Applications
  4. Relaunch

📋 For Developers

See DISTRIBUTION.md for packaging and distribution instructions.

# Build CLI
swift build

# Run CLI during development
swift run dockey project list