Quick Start Guide

Get up and running with RunLy in just a few minutes!

Installation

Install RunLy using pip:

pip install runly

Your First Justfile

Create a file named justfile in your project directory:

# Variables
project_name := "my-awesome-project"
version := "1.0.0"

# Default command (runs when you just type 'runly')
*test:
    echo "Running tests for {{project_name}}"
    python -m pytest tests/

# Build the project
build target="debug":
    echo "Building {{project_name}} v{{version}} in {{target}} mode"
    python setup.py build

# Clean build artifacts
clean:
    echo "Cleaning build artifacts"
    rm -rf build/ dist/ *.egg-info/

# Deploy to production (depends on build)
deploy env: build
    echo "Deploying {{project_name}} to {{env}}"
    ./deploy.sh {{env}}

Running Commands

List Available Commands

runly --list

Run the Default Command

runly
# or explicitly:
runly test

Run Commands with Arguments

# Build in release mode
runly build release

# Deploy to staging environment
runly deploy staging

Verbose Output

runly --verbose test

Understanding Dependencies

Commands can depend on other commands. When you run a command with dependencies, RunLy automatically runs the dependencies first:

# This command depends on 'test'
build: test
    echo "Building after tests pass"

# This command depends on 'build' (which depends on 'test')
deploy: build
    echo "Deploying built project"

When you run runly deploy, it will automatically:

  1. Run test first

  2. Then run build

  3. Finally run deploy

Variable Expansion

RunLy supports multiple variable syntax styles:

name := "myproject"
version := "1.0.0"

info:
    echo "Project: {{name}}"     # Just/RunLy style
    echo "Version: ${version}"   # Shell style
    echo "Build: $name-$version" # Short shell style

Next Steps