Installation

This guide will help you install Runnem and get it running on your system.

Prerequisites

Python 3.8 or later
pip package manager
A terminal/command prompt

Installing Runnem

Install Runnem globally using pip:

pip install runnem

Verifying the Installation

After installation, verify that Runnem is installed correctly:

runnem --version

This should display the installed version of Runnem.

System Requirements

Operating Systems

Runnem is compatible with:

Linux
macOS
Windows (with WSL)

Python Version

Runnem requires Python 3.8 or later. To check your Python version:

python --version

Common Installation Issues

Permission Errors

If you encounter permission errors during installation, try:

pip install --user runnem

Example Configuration

Here's a realistic example of a Runnem configuration that manages both an API and frontend service:

services:
  api:
    command: |
      cd ~/projects/myproject/api && \
      if [ ! -f "localhost.pem" ] || [ ! -f "localhost-key.pem" ]; then \
          echo "SSL certificates not found! Generating with mkcert..." && \
          mkcert localhost; \
      fi && \
      direnv exec . poetry run uvicorn app.main:api --reload --port 8000 --log-level debug \
      --ssl-keyfile localhost-key.pem --ssl-certfile localhost.pem
    url: https://localhost:8000/docs

  auth-router:
    command: cd ~/projects/auther/server && direnv exec . poetry run uvicorn app.main:api --reload --port 8000 --log-level debug
    url: http://localhost:8000/doc

  frontend:
    command: cd ~/projects/myproject/frontend && npm run dev
    url: http://localhost:3000
    depends_on: ["api"]

This example shows:

API service with SSL certified Python backend setup
Authentication router API, a shared service for multiple projects
Frontend service with npm-based development server
Service dependencies
Full path directory structure
URLs for opening services in the browser