Core Features

Service Management

runnem provides a simple way to manage multiple services in your project. Each service runs in its own GNU screen session, making it easy to start, stop, and monitor your services.

Starting Services

Start all services in your project:

runnem up

Start a specific service:

runnem up api

When starting services, runnem will:

  1. Check for port conflicts
  2. Start services in dependency order
  3. Wait for dependent services to be ready
  4. Show status messages for each service

Stopping Services

Stop all services:

runnem down

Stop a specific service:

runnem down api

When stopping services, runnem will:

  1. Stop the specified service(s)
  2. Clean up any processes using the service's ports

Listing Services

View the status of all services:

runnem list
# or
runnem ls

This will show:

  • Which services are running
  • The URLs of running services
  • The status of each service (Running/Stopped)

Viewing Logs

View logs for a specific service:

runnem log api

This will:

  1. Attach to the service's screen session
  2. Show the service's output
  3. Allow you to scroll through the logs
  4. Press Ctrl+A then D to detach from the logs

Port Management

If a service fails to start due to a port conflict, you can kill the process using the port:

runnem kill 3000

This will:

  1. Find any process using port 3000
  2. Kill the process
  3. Clean up the port for your service

Best Practices

  1. Define URLs for your services so that you can command click to open then up from runnem ls
  2. If needed, use dependencies to ensure services start in the correct order
  3. Check logs when services fail to start
  4. Keep your runnem.yaml file in version control
Previous
Quickstart