[GH-ISSUE #52] [Implementation] Update Config and Docs for New Adapters #16

Closed
opened 2026-02-27 10:21:47 +03:00 by kerem · 2 comments
Owner

Originally created by @mikeyobrien on GitHub (Jan 12, 2026).
Original GitHub issue: https://github.com/mikeyobrien/ralph-orchestrator/issues/52

Ref: #48

Task: Update Configuration and Documentation for New Adapters

Description

Update the core configuration (ralph.yml), the orchestrator logic (orchestrator.py), and the project documentation to fully support and register the new AmpAdapter and CopilotAdapter.

Background

After implementing the adapters for Amp and Copilot (Tasks 01 and 02), they need to be registered in the system so users can select them via ralph.yml or the CLI arguments. Documentation must also be updated to explain how to install the necessary CLI tools and configure Ralph to use them.

Reference Documentation

Required:

  • Config: ralph.yml
  • Logic: src/ralph_orchestrator/orchestrator.py

Additional References:

  • docs/guide/configuration.md (if exists)

Note: Ensure backward compatibility is maintained.

Technical Requirements

  1. Update src/ralph_orchestrator/orchestrator.py:
    • Import AmpAdapter and CopilotAdapter.
    • Add "amp" and "copilot" to _KNOWN_ADAPTERS.
    • Update _initialize_adapters to instantiate these adapters when enabled.
    • Update _normalize_agent_name to handle aliases (e.g., gh-copilot -> copilot).
  2. Update ralph.yml:
    • Add default configuration sections for amp and copilot under adapters.
    • Set default enabled: true (or false if preferred for experimental features, but user asked to add support).
  3. Update Documentation:
    • Update README.md listing supported agents.
    • Create or update a guide in docs/ explaining prerequisites (installing amp CLI, gh CLI).

Dependencies

  • Task 01 (Amp Adapter)
  • Task 02 (Copilot Adapter)

Implementation Approach

  1. Modify orchestrator.py to import and init the new classes.
  2. Add sections to ralph.yml.
  3. Add text to README.md about new support.

Acceptance Criteria

  1. Configuration Support

    • Given ralph.yml with agent: amp
    • When Ralph starts
    • Then it initializes the Amp adapter
  2. Orchestrator Registration

    • Given agent: copilot
    • When Ralph starts
    • Then it initializes the Copilot adapter
  3. Documentation

    • Given README.md
    • When read
    • Then it mentions Amp and GitHub Copilot support

Metadata

  • Complexity: Low
  • Labels: Configuration, Documentation, Orchestration
  • Required Skills: Python, YAML, Technical Writing
Originally created by @mikeyobrien on GitHub (Jan 12, 2026). Original GitHub issue: https://github.com/mikeyobrien/ralph-orchestrator/issues/52 # Ref: #48 # Task: Update Configuration and Documentation for New Adapters ## Description Update the core configuration (`ralph.yml`), the orchestrator logic (`orchestrator.py`), and the project documentation to fully support and register the new `AmpAdapter` and `CopilotAdapter`. ## Background After implementing the adapters for Amp and Copilot (Tasks 01 and 02), they need to be registered in the system so users can select them via `ralph.yml` or the CLI arguments. Documentation must also be updated to explain how to install the necessary CLI tools and configure Ralph to use them. ## Reference Documentation **Required:** - Config: `ralph.yml` - Logic: `src/ralph_orchestrator/orchestrator.py` **Additional References:** - `docs/guide/configuration.md` (if exists) **Note:** Ensure backward compatibility is maintained. ## Technical Requirements 1. **Update `src/ralph_orchestrator/orchestrator.py`**: - Import `AmpAdapter` and `CopilotAdapter`. - Add `"amp"` and `"copilot"` to `_KNOWN_ADAPTERS`. - Update `_initialize_adapters` to instantiate these adapters when enabled. - Update `_normalize_agent_name` to handle aliases (e.g., `gh-copilot` -> `copilot`). 2. **Update `ralph.yml`**: - Add default configuration sections for `amp` and `copilot` under `adapters`. - Set default `enabled: true` (or false if preferred for experimental features, but user asked to add support). 3. **Update Documentation**: - Update `README.md` listing supported agents. - Create or update a guide in `docs/` explaining prerequisites (installing `amp` CLI, `gh` CLI). ## Dependencies - Task 01 (Amp Adapter) - Task 02 (Copilot Adapter) ## Implementation Approach 1. Modify `orchestrator.py` to import and init the new classes. 2. Add sections to `ralph.yml`. 3. Add text to `README.md` about new support. ## Acceptance Criteria 1. **Configuration Support** - Given `ralph.yml` with `agent: amp` - When Ralph starts - Then it initializes the Amp adapter 2. **Orchestrator Registration** - Given `agent: copilot` - When Ralph starts - Then it initializes the Copilot adapter 3. **Documentation** - Given `README.md` - When read - Then it mentions Amp and GitHub Copilot support ## Metadata - **Complexity**: Low - **Labels**: Configuration, Documentation, Orchestration - **Required Skills**: Python, YAML, Technical Writing
kerem closed this issue 2026-02-27 10:21:47 +03:00
Author
Owner

@fakebizprez commented on GitHub (Jan 12, 2026):

Documentation is contradictory. This thing ran in a sandbox for six hours burning Gemini tokens while repeatedly creating the same file., yet the ralph status output makes it appear as everything is going as planned.

<!-- gh-comment-id:3740022731 --> @fakebizprez commented on GitHub (Jan 12, 2026): Documentation is contradictory. This thing ran in a sandbox for six hours burning Gemini tokens while repeatedly creating the same file., yet the `ralph status` output makes it appear as everything is going as planned.
Author
Owner

@mikeyobrien commented on GitHub (Jan 12, 2026):

@fakebizprez were you running through -a gemini or -a acp --acp-agent gemini?

<!-- gh-comment-id:3740576277 --> @mikeyobrien commented on GitHub (Jan 12, 2026): @fakebizprez were you running through `-a gemini` or `-a acp --acp-agent gemini`?
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/ralph-orchestrator#16
No description provided.