Command Reference¶

Complete reference for all RunLy command-line options and features.

Basic Usage¶

runly [OPTIONS] [COMMAND] [ARGS...]

Global Options¶

`-h, --help`¶

Show help message and exit.

runly --help
runly command --help  # Help for specific command

`--version`¶

Show program version and exit.

runly --version
# Output: RunLy 0.1.1

`-f FILE, --file FILE`¶

Specify path to the justfile or configuration file.

runly -f my-tasks.yml build
runly --file custom-justfile test

Default behavior: RunLy searches for files in this order:

justfile
Justfile
.justfile
runly.yaml
runly.yml

`-l, --list`¶

List all available commands and their descriptions.

runly --list

Example output:

Available commands:
  test (default)         Run the test suite
  build        target    Build the project
  deploy       env       Deploy to environment
  clean                  Clean build artifacts

`-q, --quiet`¶

Suppress output from RunLy (but not from the commands themselves).

runly --quiet test

`-d, --dry-run`¶

Print commands that would be executed without actually running them.

runly --dry-run deploy production

Example output:

Would execute: ./run-tests.sh
Would execute: python setup.py build
Would execute: ./deploy.sh production

`-v, --verbose`¶

Enable verbose output showing detailed execution information.

runly --verbose build

Verbose output includes:

Command resolution process
Dependency execution order
Variable expansion details
Execution timing

Command Execution¶

Running Commands¶

# Run default command
runly

# Run specific command
runly test

# Run command with arguments
runly build release
runly deploy staging

Command Arguments¶

Commands can accept positional and named arguments:

# Positional arguments
deploy env:
    ./deploy.sh {{env}}

# Named arguments with defaults
build target="debug":
    cargo build --profile {{target}}

Usage examples:

# Positional argument
runly deploy production

# Override default value
runly build release

Exit Codes¶

RunLy uses standard exit codes to indicate execution status:

Exit Code	Meaning	Description
`0`	Success	Command completed successfully
`1`	General Error	Command failed or general error occurred
`2`	Command Not Found	Specified command doesn’t exist
`3`	Dependency Error	Command dependency failed or circular dependency
`4`	Configuration Error	Invalid justfile or configuration
`5`	File Not Found	Justfile or specified file not found

Environment Variables¶

RunLy Environment Variables¶

Variable	Description	Default
`RUNLY_FILE`	Default justfile path	Search standard locations
`RUNLY_VERBOSE`	Enable verbose mode	`false`
`RUNLY_DRY_RUN`	Enable dry-run mode	`false`
`RUNLY_QUIET`	Enable quiet mode	`false`

Example:

$env:RUNLY_VERBOSE = "true"
$env:RUNLY_FILE = "my-tasks.yml"
runly test

Common Errors and Solutions¶

Command Not Found¶

$ runly nonexistent
Error: Command 'nonexistent' not found.

Available commands:
  test
  build
  deploy

Solution: Check command spelling or use runly --list to see available commands.

Circular Dependencies¶

# This creates a circular dependency
build: deploy
deploy: build

$ runly build
Error: Circular dependency detected: build -> deploy -> build

Solution: Remove circular dependencies from your justfile.

Missing Required Arguments¶

deploy env:  # env is required
    ./deploy.sh {{env}}

$ runly deploy
Error: Command 'deploy' requires argument: env
Usage: runly deploy <env>

Solution: Provide the required argument or add a default value.

Integration Examples¶

Docker¶

docker-build tag="latest":
    docker build -t myapp:{{tag}} .

docker-run port="8000": docker-build
    docker run -p {{port}}:8000 myapp:latest

NPM/Node.js¶

install:
    npm ci

build: install
    npm run build

test: install
    npm test

dev: install
    npm run dev