Skip to main content

A service manager for managing multiple services in a project

Project description

Runnem

Light-weight service manager for local project development. Makes switching between projects a breeze.

Why Runnem?

  • One command to rule them all – start, stop and inspect every service in your project without memorising half-a-dozen shell scripts.
  • Native speed & tooling – runs processes directly (no mandatory Docker), leveraging battle-tested GNU screen under the hood.
  • Port-safe project switching – makes it easy to switch between projects while avoiding port clashes.

Installation

pip install runnem   # Python ≥ 3.8 on Linux, macOS or WSL-enabled Windows

Quick start

# 1 · Create a config for the current directory
runnem init myproject            # omit the name to use the folder name

# 2 · Edit runnem.yaml and add your services
$EDITOR runnem.yaml

# 3 · Launch everything
runnem up                        # starts all services in the right order

# 4 · Check what’s running
runnem list                      # or: runnem ls

# 5 · Stop when you’re done
runnem down                      # stops every service cleanly

Tip: Need only one service? Pass its name to up or down, e.g. runnem up api.

Configuration example (runnem.yaml)

project_name: myproject  # required

services:
  database:
    command: cd database && docker-compose up
    url: postgresql://localhost:5432

  api:
    command: cd api && poetry run uvicorn main:app --reload --port 8000
    url: http://localhost:8000/health
    depends_on: [database]

  frontend:
    command: cd frontend && npm run dev
    url: http://localhost:3000
    depends_on: [api]
Key Required Description
command Shell command executed inside its own screen session.
url Health-check endpoint and source of the port number; Runnem waits for it to respond before starting dependants.
depends_on List of service names that must be running first.

Ports are inferred from the url – specify one if you want automatic conflict resolution.

Everyday commands

Task Command
Start all services runnem up
Start one service runnem up <service>
Stop all services runnem down
Stop one service runnem down <service>
View live logs runnem log <service>
List status runnem list (or ls)
Free a busy port runnem kill <port>

Multiple projects

Runnem looks for the nearest runnem.yaml when you run a command.
If services from another project are still running you’ll see a warning and can stop them with:

runnem down     # executed from *any* project directory

Contributing

Found a bug, want a feature or to polish the docs? PRs are welcome!

  • Fork the repo & git clone it.
  • pip install -e . inside a virtualenv.
  • Create a feature branch (git switch -c my-fix).
  • Commit with clear messages and open a PR.

License

MIT © 2025 Runnem contributors

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

runnem-0.1.2.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

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

runnem-0.1.2-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file runnem-0.1.2.tar.gz.

File metadata

  • Download URL: runnem-0.1.2.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for runnem-0.1.2.tar.gz
Algorithm Hash digest
SHA256 dac14d9eaece3dff28aed933f6b1047be01b7ad63614b23bd10d591851b52933
MD5 6791e923c489cf3f1f64b94328072237
BLAKE2b-256 51f0c6fa925417c5905b0e7df27e1ca0792d124ee188ad7eccbaced8ebd2d434

See more details on using hashes here.

File details

Details for the file runnem-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: runnem-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for runnem-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 372d74edf39c28739ce8440f00dc6c7332d661ba602463ffc49b79789a9701fd
MD5 7c31eff4c16ec7d88f4625a278f88835
BLAKE2b-256 6adc1ea23ffbff6ed3d8adfcde09ea6c436ec850ea4c047756e23208e01581f7

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