Ralphex

https://ralphex.com/docs
Admin
Ralphex is a CLI tool that orchestrates Claude Code to autonomously execute implementation plans...
Tokens:5,584
Snippets:58
Trust Score:7.5
Update:8 months ago
Show doc for...
Tokens:
Raw
### Template Variable Expansion in Ralphex

Source: https://ralphex.com/docs/index

Ralphex supports variable expansion in prompt files using the {{VARIABLE}} syntax. These variables can represent file paths, goals, default branches, or agent instructions. The example shows how to launch multiple review agents in parallel, with each agent's instructions being expanded.

```text
Launch the following review agents in parallel:
{{agent:quality}}
{{agent:implementation}}
{{agent:testing}}


```

--------------------------------

### Ralphex Agent File Comments and Content

Source: https://ralphex.com/docs/index

Agent files in Ralphex support comments starting with '#'. Lines beginning with '#' are stripped during loading. This allows for documentation within agent files. The example shows a commented security agent definition.

```text
# security agent - checks for vulnerabilities
# updated: 2024-01-15
check for SQL injection
check for XSS


```

--------------------------------

### Referencing Claude Code Agents Directly in Prompts

Source: https://ralphex.com/docs/index

Instead of creating separate agent files, Ralphex allows direct referencing of agents installed in Claude Code within prompt files. The example shows how to list agents and their associated prompts within a review file like `review_first.txt`.

```text
# in review_first.txt - just list agent names with their prompts
Agents to launch:
1. qa-expert - "Review for bugs and security issues"
2. go-test-expert - "Review test coverage and quality"
3. go-smells-expert - "Review for code smells"


```

--------------------------------

### Ralphex Configuration Directory Structure

Source: https://ralphex.com/docs/index

The global configuration for Ralphex is located at `~/.config/ralphex/`. This directory contains the main configuration file, custom prompt templates, and custom review agent files. The structure is shown in the example.

```ini
~/.config/ralphex/
├── config              # main configuration file (INI format)
├── prompts/            # custom prompt templates
│   ├── task.txt
│   ├── review_first.txt
│   ├── review_second.txt
│   └── codex.txt
└── agents/             # custom review agents (*.txt files)


```

--------------------------------

### Project-Local Ralphex Configuration

Source: https://ralphex.com/docs/index

Projects can override global Ralphex settings by including a `.ralphex/` directory in the project root. This directory can contain its own `config`, `prompts/`, and `agents/` subdirectories, allowing for project-specific customizations.

```ini
project/
├── .ralphex/           # optional, project-local config
│   ├── config          # overrides specific settings
│   ├── prompts/        # custom prompts for this project
│   └── agents/         # custom agents for this project


```
Tokens:
Raw