Quickstart

Get up and running with runnem in just a few simple steps. This guide will help you set up your first project and start managing your services.

Step 1: Initialize Your Project

Create a configuration for your current directory:

runnem init myproject  # omit the name to use the folder name

This creates a runnem.yaml file in your project directory.

Step 2: Configure Your Services

Edit the runnem.yaml file to define your services:

$EDITOR runnem.yaml

For detailed configuration examples, see the Installation page.

Step 3: Start Your Services

Launch all your services with a single command:

runnem up  # starts all services in the right order

Step 4: Monitor Your Services

Check what's running at any time:

runnem list  # or: runnem ls

Step 5: Stop Your Services

When you're done, stop all services cleanly:

runnem down  # stops every service cleanly

Next Steps

Now that you've got the basics down, you might want to explore:

• Service Management - Learn more about managing your services
• Dependency Management - Understand how to manage service dependencies
• YAML Configuration - Dive deeper into configuration options