Skip to main content

Developer experience CLI for Docker Compose monorepos — service scaffolding, port management, and project health checks

Project description

dx — Developer Experience CLI

A zero-dependency CLI for managing Docker Compose monorepos. Handles service lifecycle, port management, code generation, and project health checks.

Install

pip install dx-cli

Or install from source:

pip install -e dx-cli/

Quick Start

dx up                     # Start all services
dx dev                    # Start with hot-reload
dx down                   # Stop everything
dx ps                     # Show running containers
dx logs service-data      # Stream logs

Commands

Docker Lifecycle

Command Description
dx up [targets...] Start services (prod mode)
dx dev [targets...] Start services (dev mode + hot-reload)
dx down [targets...] Stop and remove containers
dx restart [targets...] Restart containers
dx reset [targets...] Stop + wipe volumes
dx ps Show running containers
dx logs [targets...] Stream container logs
dx pull [targets...] Pull images
dx reload <service> Recompile Java service for DevTools restart

Build / Test / Lint

Command Description
dx build [targets...] Build services (all, common, or names)
dx test [targets...] Run tests (all or service names)
dx lint [targets...] Run linters (all, frontend, python)

Service Scaffolding

Command Description
dx generate python <name> Scaffold a new Python/FastAPI service
dx generate java <name> Scaffold a new Java/Spring Boot service

Generated services include Dockerfiles, compose entries, health checks, config, and agent guides.

Port Management

Command Description
dx ports Show port assignments
dx ports pin <svc> <port> Pin a service to a specific port
dx ports reset [service] Clear port reservations

Ports are auto-allocated for all services (infra, services, apps) and persisted in .dx/ports.json.

Project Health

Command Description
dx doctor Check project structure, Dockerfiles, and conventions
dx doctor --fix Auto-fix issues in compose files and Dockerfiles

Checks include:

  • Compose service naming conventions
  • Required files per service type (Dockerfile, pom.xml, pyproject.toml)
  • Java Dockerfile module sync with pom.xml
  • Hardcoded ports (auto-fixable)
  • Missing Dockerfile references

Proxy & DNS

Command Description
dx proxy start Start reverse proxy on :7355
dx proxy stop Stop reverse proxy
dx hosts setup Add *.dx.localhost DNS entries

Access services at http://<service>.dx.localhost:7355.

Target Resolution

Targets can be:

  • Group names: infra, services, apps
  • Service names: service-data, infra-postgres
  • Shorthand: data, ai, frontend
  • Glob patterns: service-d*, app-*-ui

Compose File Convention

docker-compose.infra.yml          # Infrastructure (prefix: infra-*)
docker-compose.services.yml       # Backend services (prefix: service-*)
docker-compose.apps.yml           # Frontend apps (prefix: app-*)
docker-compose.dev.services.yml   # Dev overlay for services
docker-compose.dev.apps.yml       # Dev overlay for apps

Requirements

  • Python 3.11+
  • Docker with Compose v2
  • No Python dependencies (zero-dependency CLI)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dx_cli-0.5.0.tar.gz (49.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dx_cli-0.5.0-py3-none-any.whl (52.8 kB view details)

Uploaded Python 3

File details

Details for the file dx_cli-0.5.0.tar.gz.

File metadata

  • Download URL: dx_cli-0.5.0.tar.gz
  • Upload date:
  • Size: 49.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for dx_cli-0.5.0.tar.gz
Algorithm Hash digest
SHA256 fa4a049c7df3486e14229b4918bfe2d0f61f6b8d140a215c34576d0fbb5154d9
MD5 831f2ca3ff3364fda3b6e2b278fdbb89
BLAKE2b-256 2668ae3db79b8725af015b6d300796f5d35d0174dd0ca255a0d99f6bba1f59e6

See more details on using hashes here.

File details

Details for the file dx_cli-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: dx_cli-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 52.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for dx_cli-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 72351f4cbe3ae3d6362c0cd43dc549d48c08eb4113cba0b2cb6dadac9779df61
MD5 0d9663cfcbd97af5621eb84aa7a7f865
BLAKE2b-256 8d368931ca269ed76f1862a45f378f33823b84a2e99ff3460c85ee3c7a21ff60

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page