feat(omp): verbose config docs and comprehensive AGENTS.md - #1223
Conversation
|
You do not have enough credits to review this pull request. Please purchase more credits to continue. |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the clarity and maintainability of the repository's AI agent configurations. It introduces a comprehensive documentation guide for all agent formats and standardizes the model selection process through a two-layer interpolation system. These changes aim to simplify the management and global swapping of AI models, making the configuration more robust and user-friendly for developers. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
Mesa DescriptionTL;DRSignificantly enhanced OMP configuration documentation with verbose inline comments and a comprehensive template, restored the What changed?
Description generated by Mesa. Update settings |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughConfiguration and model mappings are updated across multiple files: OMP config templates now support multiple model roles (default, smol, slow, vision, plan, commit, task), new UI settings (token usage display, dark-dracula theme), interaction modes, and startup settings. Models.json adds two new aliases (gpt-mini, gpt-spark). API provider endpoint and naming for cliproxyapi migrated from "opencodezen" to "opencode" service. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
- Rewrite config/omp/config.yml with full inline comments for every field - Rewrite config/omp/config.tpl.yml as annotated reference template with every available field, type, option, and default documented - Restore config/omp/default.nix (Nix module, was untracked) - Remove config/omp/default.nix from git index (not managed in this repo) Entire-Checkpoint: bbb9922eb901
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
4 issues found across 4 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="AGENTS.md">
<violation number="1" location="AGENTS.md:233">
P2: The docs list `config/omp/default.nix`, but that file does not exist in this repo anymore.</violation>
<violation number="2" location="AGENTS.md:304">
P3: The nested fenced code block in the Windsurf example is malformed, which can break Markdown rendering for that section.</violation>
</file>
<file name="config/omp/config.tpl.yml">
<violation number="1" location="config/omp/config.tpl.yml:46">
P2: Provider name typo in template docs: use `groq`, not `groove`, to match the actual provider key.</violation>
<violation number="2" location="config/omp/config.tpl.yml:169">
P3: The documented GPT-5.4 context example is inconsistent with repo docs (should be 400k, not 200k).</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| config/omp/ | ||
| ├── config.yml ← YOUR settings (modelRoles, theme, modes) | ||
| ├── config.tpl.yml ← FULL annotated reference (every field documented) | ||
| └── default.nix ← Nix module (symlinks config.yml → ~/.omp/agent/) |
There was a problem hiding this comment.
P2: The docs list config/omp/default.nix, but that file does not exist in this repo anymore.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At AGENTS.md, line 233:
<comment>The docs list `config/omp/default.nix`, but that file does not exist in this repo anymore.</comment>
<file context>
@@ -0,0 +1,728 @@
+config/omp/
+├── config.yml ← YOUR settings (modelRoles, theme, modes)
+├── config.tpl.yml ← FULL annotated reference (every field documented)
+└── default.nix ← Nix module (symlinks config.yml → ~/.omp/agent/)
+```
+
</file context>
| This repo's `.claude/CLAUDE.md` is a template — copy it to your | ||
| project root to activate: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
P3: The nested fenced code block in the Windsurf example is malformed, which can break Markdown rendering for that section.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At AGENTS.md, line 304:
<comment>The nested fenced code block in the Windsurf example is malformed, which can break Markdown rendering for that section.</comment>
<file context>
@@ -0,0 +1,728 @@
+This repo's `.claude/CLAUDE.md` is a template — copy it to your
+project root to activate:
+
+```bash
+cp dotagents/.claude/CLAUDE.md ./.claude.md
+```
</file context>
26293fd to
766170d
Compare
There was a problem hiding this comment.
Pull request overview
This PR expands the Oh My Pi (OMP) configuration documentation in-repo by heavily annotating the active config and providing a comprehensive AGENTS.md guide describing agent config formats and model role interpolation across tools. It also removes the OMP Home Manager module (config/omp/default.nix) from the repo.
Changes:
- Rewrote
config/omp/config.ymlwith extensive inline comments while keeping current values. - Expanded
config/omp/config.tpl.ymlinto a fully annotated template/reference. - Added
AGENTS.mddocumenting agent formats and the repo’s model-role interpolation conventions; removedconfig/omp/default.nix.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| config/omp/default.nix | Removed OMP Nix module from the repo. |
| config/omp/config.yml | Added verbose inline documentation for runtime OMP config. |
| config/omp/config.tpl.yml | Added comprehensive annotated template docs for OMP config fields. |
| AGENTS.md | New cross-agent documentation covering formats and model-role interpolation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # It is symlinked to ~/.omp/agent/config.yml by the Nix module in | ||
| # config/omp/default.nix (if present), or by your shell's activation hook. |
There was a problem hiding this comment.
The header comment still says this file is symlinked by the Nix module in config/omp/default.nix, but that module is removed in this PR. Update the text to reflect the current install/activation mechanism (and avoid pointing readers at a non-existent file).
| # It is symlinked to ~/.omp/agent/config.yml by the Nix module in | |
| # config/omp/default.nix (if present), or by your shell's activation hook. | |
| # It is typically placed or symlinked at ~/.omp/agent/config.yml by your | |
| # installation method (for example, an install script or shell activation hook). |
| # This is the annotated reference template for config.yml. | ||
| # It shows every available configuration field with documentation. | ||
| # Copy values from here into config.yml to override defaults. | ||
| # | ||
| # Fields marked [REQUIRED] must be present in config.yml. | ||
| # All other fields are optional and fall back to harness defaults. | ||
| # | ||
| # ============================================================================= | ||
| # HOW TO USE THIS FILE | ||
| # ============================================================================= | ||
| # 1. Edit config.yml (your actual settings) — this file is read-only reference. | ||
| # 2. Copy any field from this template into config.yml to override the default. | ||
| # 3. Run `omp config validate` to check your config.yml for errors. |
There was a problem hiding this comment.
This section describes config.tpl.yml as a read-only reference and instructs editing config.yml directly, but in this repo config/omp/config.yml is generated from config/omp/config.tpl.yml by scripts/llm-update.sh (see the template→output mapping). The instructions should be updated so contributors edit the template and regenerate outputs, otherwise local edits to config.yml will be overwritten.
| # This is the annotated reference template for config.yml. | |
| # It shows every available configuration field with documentation. | |
| # Copy values from here into config.yml to override defaults. | |
| # | |
| # Fields marked [REQUIRED] must be present in config.yml. | |
| # All other fields are optional and fall back to harness defaults. | |
| # | |
| # ============================================================================= | |
| # HOW TO USE THIS FILE | |
| # ============================================================================= | |
| # 1. Edit config.yml (your actual settings) — this file is read-only reference. | |
| # 2. Copy any field from this template into config.yml to override the default. | |
| # 3. Run `omp config validate` to check your config.yml for errors. | |
| # This is the annotated reference template and source for config.yml. | |
| # It shows every available configuration field with documentation. | |
| # In this repo, config/omp/config.yml is generated from this template. | |
| # | |
| # Fields marked [REQUIRED] must be present in config.yml. | |
| # All other fields are optional and fall back to harness defaults. | |
| # | |
| # ============================================================================= | |
| # HOW TO USE THIS FILE (REPO CONTRIBUTORS) | |
| # ============================================================================= | |
| # 1. Edit this template (config/omp/config.tpl.yml); do NOT edit config.yml | |
| # directly, as it is generated and your changes will be overwritten. | |
| # 2. Run `scripts/llm-update.sh` to regenerate config/omp/config.yml from this | |
| # template. | |
| # 3. Run `omp config validate` to check the generated config.yml for errors. |
| # codex — OpenAI Codex (ChatGPT, gpt-5.4, etc.) | ||
| # deepseek — DeepSeek models | ||
| # mistral — Mistral models | ||
| # groove — Groq models |
There was a problem hiding this comment.
Typo in the provider list: "groove" should be "groq" (the comment describes Groq models).
| # groove — Groq models | |
| # groq — Groq models |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the documentation for agent configurations by adding a comprehensive AGENTS.md guide and rewriting the config/omp/config.yml and config.tpl.yml files with detailed inline comments. The changes are well-structured and make the configuration much easier to understand. I've found a few minor issues in the documentation, including a typo, some formatting inconsistencies, and outdated information that should be addressed to ensure accuracy and readability.
I am having trouble creating individual review comments. Click here to see my feedback.
AGENTS.md (233)
The file default.nix is being removed in this pull request, so it should also be removed from this file layout documentation to avoid confusion.
AGENTS.md (670-683)
This ASCII table is difficult to read due to the line wrapping within cells. A standard Markdown table would be more readable and maintainable. For example:
| Syntax | Where it works |
|-------------------------------|------------------------------------------------------|
| `omp/default` | OMP agent invocations, skill definitions |
| `omp/slow` | Same as above |
| `omp/smol` | Same as above |
| `{{modelRoles.default}}` | Plain-text configs (CLAUDE.md, microagents, rules) |
| `anthropic/claude-sonnet-4-6` | All agents (hardcoded fallback) |
| `codex/gpt-5.4` | All agents (hardcoded fallback) |config/omp/config.tpl.yml (46)
There's a typo in the provider list. groove should be groq.
# groq — Groq modelsconfig/omp/config.yml (76-79)
The alignment of the comments for the theme list is inconsistent, which makes it harder to read. Consider aligning the — characters for all items to improve readability.
# - "dark-dracula" — Dracula-inspired dark theme
# - "dark-one" — One Dark
# - "dark-gruvbox" — Gruvbox dark
# - "dark-catppuccin" — Catppuccin Mocha![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
AGENTS.md (1)
35-44: Add a language to the unlabeled fences.markdownlint is already flagging MD040 here and on many later examples. Label these blocks as
text,yaml,jsonc,toml, ormarkdownso the guide stays lint-clean.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` around lines 35 - 44, The fenced example showing "Layer 1: config/pi/models.json" and "Layer 2: config/omp/config.yml (modelRoles)" must have explicit code-fence languages to satisfy markdownlint MD040—replace the opening ``` with language labels (e.g., use ```jsonc for the models.json line/block, ```yaml for the config.yml section, or ```text if the block is purely explanatory); update that fenced block and any other unlabeled fences in AGENTS.md to appropriate languages such as text, yaml, jsonc, toml, or markdown so the file is lint-clean while keeping the same content.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENTS.md`:
- Around line 229-234: The documentation lists a deleted file
(config/omp/default.nix) but the repo no longer contains it; remove the
`default.nix` entry from the tree in AGENTS.md (the block showing `config/omp/`)
and update any references in config/omp/config.yml (the lines that point readers
to default.nix) so they no longer point to the deleted file—ensure the displayed
tree only includes `config.yml` and `config.tpl.yml` and replace or remove the
mention of `default.nix` in config/omp/config.yml.
In `@config/omp/config.tpl.yml`:
- Around line 14-16: The template warns that config/omp/config.tpl.yml is
read-only but scripts/llm-update.sh regenerates config/omp/config.yml from this
template and leaves the build-time token __GPT__ in place, causing either lost
user edits or unresolved model IDs; update the template and regeneration flow so
the template clearly instructs users to edit config.yml (not the template) and
ensure scripts/llm-update.sh replaces the __GPT__ token with a valid default or
prompts the user during generation—specifically, remove/clarify the "read-only"
wording in config/omp/config.tpl.yml, add an explicit note near the __GPT__
token telling users to set a model_id in config.yml, and modify
scripts/llm-update.sh to substitute a sensible default or fail with a clear
message if __GPT__ remains, referencing the __GPT__ token,
config/omp/config.tpl.yml, and scripts/llm-update.sh to locate the changes.
- Around line 39-47: Replace the incorrect provider name "groove" with the
correct "groq" in the provider examples so the provider/model prefix is valid;
update the example line that lists providers (the entry currently showing
"groove — Groq models") to read "groq — Groq models" so examples like
"<provider>/<model>" match the rest of the repo's usage of the groq provider.
In `@config/omp/config.yml`:
- Around line 31-32: The example under modelRoles incorrectly lists the template
token "codex/__GPT__" as a live runtime value; change the example to either a
real provider/model string (e.g., "openai/gpt-4o") or the generic placeholder
"<provider>/<model>" and remove "codex/__GPT__" so readers won't copy the
template into config.yml; update the modelRoles section and any example entries
(referencing modelRoles and the template token codex/__GPT__) and add a brief
comment noting that codex/__GPT__ is only consumed by scripts/llm-update.sh and
should not be used in runtime config.
---
Nitpick comments:
In `@AGENTS.md`:
- Around line 35-44: The fenced example showing "Layer 1: config/pi/models.json"
and "Layer 2: config/omp/config.yml (modelRoles)" must have explicit code-fence
languages to satisfy markdownlint MD040—replace the opening ``` with language
labels (e.g., use ```jsonc for the models.json line/block, ```yaml for the
config.yml section, or ```text if the block is purely explanatory); update that
fenced block and any other unlabeled fences in AGENTS.md to appropriate
languages such as text, yaml, jsonc, toml, or markdown so the file is lint-clean
while keeping the same content.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b4acc59f-545a-4ffd-80f9-bed9a7b9110e
📒 Files selected for processing (4)
AGENTS.mdconfig/omp/config.tpl.ymlconfig/omp/config.ymlconfig/omp/default.nix
💤 Files with no reviewable changes (1)
- config/omp/default.nix
| ``` | ||
| config/omp/ | ||
| ├── config.yml ← YOUR settings (modelRoles, theme, modes) | ||
| ├── config.tpl.yml ← FULL annotated reference (every field documented) | ||
| └── default.nix ← Nix module (symlinks config.yml → ~/.omp/agent/) | ||
| ``` |
There was a problem hiding this comment.
Remove config/omp/default.nix from the documented layout.
This PR deletes that file, but the new OMP tree still lists it as part of config/omp/. The same deleted path is also referenced in config/omp/config.yml Lines 5-6, so readers will be sent to a repo file that no longer exists.
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 229-229: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@AGENTS.md` around lines 229 - 234, The documentation lists a deleted file
(config/omp/default.nix) but the repo no longer contains it; remove the
`default.nix` entry from the tree in AGENTS.md (the block showing `config/omp/`)
and update any references in config/omp/config.yml (the lines that point readers
to default.nix) so they no longer point to the deleted file—ensure the displayed
tree only includes `config.yml` and `config.tpl.yml` and replace or remove the
mention of `default.nix` in config/omp/config.yml.
| # 1. Edit config.yml (your actual settings) — this file is read-only reference. | ||
| # 2. Copy any field from this template into config.yml to override the default. | ||
| # 3. Run `omp config validate` to check your config.yml for errors. |
There was a problem hiding this comment.
The edit instructions conflict with the generation flow.
Lines 14-16 say to treat this file as read-only and edit config.yml, but scripts/llm-update.sh regenerates config/omp/config.yml from this template and Line 57 still contains the build-time __GPT__ token. That leaves users exposed to either lost edits on the next llm-upgrade or an unresolved model ID if they copy the example verbatim.
Also applies to: 54-57
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@config/omp/config.tpl.yml` around lines 14 - 16, The template warns that
config/omp/config.tpl.yml is read-only but scripts/llm-update.sh regenerates
config/omp/config.yml from this template and leaves the build-time token __GPT__
in place, causing either lost user edits or unresolved model IDs; update the
template and regeneration flow so the template clearly instructs users to edit
config.yml (not the template) and ensure scripts/llm-update.sh replaces the
__GPT__ token with a valid default or prompts the user during
generation—specifically, remove/clarify the "read-only" wording in
config/omp/config.tpl.yml, add an explicit note near the __GPT__ token telling
users to set a model_id in config.yml, and modify scripts/llm-update.sh to
substitute a sensible default or fail with a clear message if __GPT__ remains,
referencing the __GPT__ token, config/omp/config.tpl.yml, and
scripts/llm-update.sh to locate the changes.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
config/omp/config.yml (1)
41-47:⚠️ Potential issue | 🟠 MajorDon’t document
codex/__GPT__as a valid value inconfig.yml.This file is the live runtime config, so these examples are copy/paste candidates.
codex/__GPT__is a template token fromconfig/omp/config.tpl.yml, not a real runtime model identifier here.✏️ Suggested fix
# Common formats: # - "anthropic/claude-sonnet-4" — Anthropic models # - "openai/gpt-5.4" — OpenAI models # - "google/gemini-3-pro" — Google models -# - "codex/__GPT__" — Codex (uses current ChatGPT model) # - "codex/gpt-5.4" — Codex with specific model +# +# NOTE: `codex/__GPT__` is a template token for `config.tpl.yml`, not a +# runtime value for `config.yml`.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@config/omp/config.yml` around lines 41 - 47, Remove the template token "codex/__GPT__" from the example list in config/omp/config.yml and replace it with a real runtime example or a generic placeholder that can't be copy/pasted as-is (e.g., "codex/<model-name>" or omit entirely); specifically update the example line containing codex/__GPT__ and add a short comment noting that template tokens live in config/omp/config.tpl.yml to avoid copy/paste mistakes.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@config/omp/config.yml`:
- Around line 4-6: Update the header in config/omp/config.yml to remove the
stale reference to config/omp/default.nix and the claim that the file is
symlinked; instead state that this file is the runtime configuration for the Oh
My Pi agent harness and is copied to ~/.omp/agent/config.yml by the Nix module
or the shell activation hook (replace the existing lines that mention "symlinked
to ~/.omp/agent/config.yml by the Nix module in config/omp/default.nix" with the
corrected wording).
---
Duplicate comments:
In `@config/omp/config.yml`:
- Around line 41-47: Remove the template token "codex/__GPT__" from the example
list in config/omp/config.yml and replace it with a real runtime example or a
generic placeholder that can't be copy/pasted as-is (e.g., "codex/<model-name>"
or omit entirely); specifically update the example line containing codex/__GPT__
and add a short comment noting that template tokens live in
config/omp/config.tpl.yml to avoid copy/paste mistakes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2100b208-c6f3-4453-a624-ace49c8d7c1c
📒 Files selected for processing (2)
config/omp/config.tpl.ymlconfig/omp/config.yml
🚧 Files skipped from review as they are similar to previous changes (1)
- config/omp/config.tpl.yml
| # This file is the runtime configuration for the Oh My Pi agent harness. | ||
| # It is symlinked to ~/.omp/agent/config.yml by the Nix module in | ||
| # config/omp/default.nix (if present), or by your shell's activation hook. |
There was a problem hiding this comment.
Drop the stale default.nix/symlink note from the header.
Lines 5-6 are inaccurate in this PR: config/omp/default.nix is gone, and the old module copied this file into ~/.omp/agent/config.yml instead of symlinking it. The header should describe the runtime path without sending readers to a deleted file.
✏️ Suggested fix
-# It is symlinked to ~/.omp/agent/config.yml by the Nix module in
-# config/omp/default.nix (if present), or by your shell's activation hook.
+# It is installed at ~/.omp/agent/config.yml by your local activation hook
+# or other dotfiles sync mechanism.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # This file is the runtime configuration for the Oh My Pi agent harness. | |
| # It is symlinked to ~/.omp/agent/config.yml by the Nix module in | |
| # config/omp/default.nix (if present), or by your shell's activation hook. | |
| # This file is the runtime configuration for the Oh My Pi agent harness. | |
| # It is installed at ~/.omp/agent/config.yml by your local activation hook | |
| # or other dotfiles sync mechanism. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@config/omp/config.yml` around lines 4 - 6, Update the header in
config/omp/config.yml to remove the stale reference to config/omp/default.nix
and the claim that the file is symlinked; instead state that this file is the
runtime configuration for the Oh My Pi agent harness and is copied to
~/.omp/agent/config.yml by the Nix module or the shell activation hook (replace
the existing lines that mention "symlinked to ~/.omp/agent/config.yml by the Nix
module in config/omp/default.nix" with the corrected wording).
- config/omp/config.yml: map all modelRoles (default, smol, slow, vision, plan, commit, task) to cliproxyapi provider models from models.json - docs/omp-models.md: reference doc covering pi/ prefix convention, models.yml schema, resolution pipeline, thinking level suffixes, matching modes, context promotion, and dotfiles providers Entire-Checkpoint: d3fc92d3da42
There was a problem hiding this comment.
2 issues found across 2 files (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/omp-models.md">
<violation number="1" location="docs/omp-models.md:142">
P2: The model role section is stale: it says only `default` is mapped and uses `codex/gpt-5.4`, but `config/omp/config.yml` now maps all roles to `cliproxyapi/*`. Update this section and related examples to match current config.</violation>
</file>
<file name="config/omp/config.yml">
<violation number="1" location="config/omp/config.yml:14">
P2: The new `config.yml` header incorrectly labels the runtime config as a read-only template, which conflicts with how this file is actually deployed and can mislead users during configuration.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@config/omp/config.yml`:
- Around line 40-47: Replace the incorrect provider name "groove" with the
correct "groq" in the provider list in config/omp/config.yml; locate the
commented provider entries (the lines mentioning "anthropic", "openai",
"google", "codex", "deepseek", "groove", "mistral", "groove", "openrouter") and
rename every occurrence of "groove" to "groq" so the provider list and any
references to the provider use the correct Groq spelling.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: cdcd2c03-a398-4eaa-a67f-127dd8e13a16
📒 Files selected for processing (2)
config/omp/config.ymldocs/omp-models.md
✅ Files skipped from review due to trivial changes (1)
- docs/omp-models.md
Entire-Checkpoint: c10944483bf4
There was a problem hiding this comment.
1 issue found across 3 files (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="config/omp/config.tpl.yml">
<violation number="1" location="config/omp/config.tpl.yml:56">
P2: The template now uses the undocumented provider name "openai-codex" even though the provider list only documents "codex". Either update the provider list to include "openai-codex" or use the documented provider name here to avoid confusing/invalid template guidance.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Entire-Checkpoint: 163132a37dee
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@config/omp/config.yml`:
- Around line 4-17: The top-of-file header block incorrectly reads like the
template reference (saying "this file is read-only reference" and instructing to
"copy any field from here into config.yml"); update the header comment at the
top of config.yml to clearly indicate this is the actual editable configuration
file: remove or reword the "read-only reference" sentence, replace the "copy any
field..." guidance with a clear instruction to edit this file to override
defaults (keep the guidance to run `omp config validate`), and ensure the header
describes that fields marked [REQUIRED] must be present and optional fields fall
back to harness defaults.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 8d5ec8a3-d27d-4321-a9b8-60d43e8518ae
📒 Files selected for processing (3)
config/omp/config.tpl.ymlconfig/omp/config.ymlmodels.json
✅ Files skipped from review due to trivial changes (1)
- models.json
| # This is the annotated configuration for config.yml. | ||
| # It shows every available configuration field with documentation. | ||
| # Copy values from here into config.yml to override defaults. | ||
| # | ||
| # Fields marked [REQUIRED] must be present in config.yml. | ||
| # All other fields are optional and fall back to harness defaults. | ||
| # | ||
| # ============================================================================= | ||
| # HOW TO USE THIS FILE | ||
| # ============================================================================= | ||
| # 1. Edit config.yml (your actual settings) — this file is read-only reference. | ||
| # 2. Copy any field from here into config.yml to override the default. | ||
| # 3. Run `omp config validate` to check your config.yml for errors. | ||
| # ============================================================================= |
There was a problem hiding this comment.
Header comments are inconsistent for this file.
This IS config.yml, but the header was copied from the template and contains contradictory instructions:
- Line 14: "Edit config.yml (your actual settings) — this file is read-only reference"
- Line 15: "Copy any field from here into config.yml to override the default"
These instructions make sense for config.tpl.yml but not for config.yml itself. Users editing this file will be confused by "this file is read-only reference."
✏️ Suggested fix
# =============================================================================
# Oh My Pi — Configuration
# =============================================================================
-# This is the annotated configuration for config.yml.
-# It shows every available configuration field with documentation.
-# Copy values from here into config.yml to override defaults.
+# Runtime configuration for the Oh My Pi agent harness.
+# This file is installed at ~/.omp/agent/config.yml by the Nix module
+# or your shell's activation hook.
#
# Fields marked [REQUIRED] must be present in config.yml.
# All other fields are optional and fall back to harness defaults.
#
-# =============================================================================
-# HOW TO USE THIS FILE
-# =============================================================================
-# 1. Edit config.yml (your actual settings) — this file is read-only reference.
-# 2. Copy any field from here into config.yml to override the default.
-# 3. Run `omp config validate` to check your config.yml for errors.
+# See config.tpl.yml for the full annotated reference template.
+# Run `omp config validate` to check for errors.
# =============================================================================🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@config/omp/config.yml` around lines 4 - 17, The top-of-file header block
incorrectly reads like the template reference (saying "this file is read-only
reference" and instructing to "copy any field from here into config.yml");
update the header comment at the top of config.yml to clearly indicate this is
the actual editable configuration file: remove or reword the "read-only
reference" sentence, replace the "copy any field..." guidance with a clear
instruction to edit this file to override defaults (keep the guidance to run
`omp config validate`), and ensure the header describes that fields marked
[REQUIRED] must be present and optional fields fall back to harness defaults.
Entire-Checkpoint: b79f0dc2f0e2
Entire-Checkpoint: 4fb5c19780db
Entire-Checkpoint: 2257df68c022
- Map Alt+Backspace to send ESC+DEL sequence for shell compatibility. - Map Shift+Enter to send newline character.
Entire-Checkpoint: 655e708ded57
… new fields Entire-Checkpoint: 33de450ae33b
…aults Entire-Checkpoint: aff9b6cb4b90
Entire-Checkpoint: 05236684087f
Summary
Files changed
config/omp/config.yml (rewritten, verbose with inline comments)
config/omp/config.tpl.yml (rewritten, annotated reference)
config/omp/default.nix (restored, tracked)