🤖 feat: add custom modes system with .mux/modes/*.md files #1312
+1,126
−48
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replace the hardcoded exec/plan toggle with a flexible, user-extensible
mode system defined via markdown files with YAML frontmatter.
Key changes:
- Add ModeDefinition types and Zod schemas in src/common/types/mode.ts
- Create ModeLoaderService to discover and load modes from:
- Built-in modes (bundled in src/node/builtinModes/)
- Global modes (~/.mux/modes/)
- Project modes (.mux/modes/) - highest priority
- Add modes.list and modes.get IPC endpoints
- Refactor ModeSelector from ToggleGroup to Select dropdown
- Add useModes hook for frontend mode fetching
- Support 'disabled: true' in mode files to hide/replace built-in modes
Mode file format (example .mux/modes/custom.md):
```yaml
---
name: custom
label: Custom Mode
description: A custom agent behavior mode
icon: 🔧
color: var(--color-custom)
toolPolicy:
- regex: some_tool
action: enable
---
Mode-specific instructions go here...
```
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Add null check for api.modes?.list to prevent crashes in Storybook where the full API context may not be available.
Fix path from __dirname/builtinModes to __dirname/../builtinModes since modeLoaderService.ts is in src/node/services/ not src/node/.
The mode selector changed from a ToggleGroup to a Select dropdown. Update the setMode utility to click the combobox trigger and select the option from the dropdown menu.
- Add docs/modes.mdx with comprehensive modes documentation - Extend gen_docs.ts to generate built-in modes section from src/node/builtinModes/*.md - Add modes.mdx to docs navigation - Fix markdown formatting in plan.md for Prettier compatibility
- Remove emoji from mode selector - Style trigger to match original toggle group appearance - Hide chevron, use compact pill style with mode-specific colors - Simplify dropdown items to plain labels
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Replace the hardcoded exec/plan toggle with a flexible, user-extensible mode system. Modes are defined via markdown files with YAML frontmatter in
.mux/modes/directories.Key Changes
Types & Schemas
src/common/types/mode.tswithModeDefinitioninterface and related schemasBackend
src/node/services/modeLoaderService.ts): Discovers and loads modes from:src/node/builtinModes/)~/.mux/modes/).mux/modes/) - highest prioritymodes.listandmodes.getIPC endpointsFrontend
useModeshook for fetching available modesBuilt-in Modes
exec.md- Full execution mode (default)plan.md- Read-only planning mode with propose_planMode File Format
Testing
make static-check)Future Work (not in this PR)
Generated with
mux• Model:anthropic:claude-opus-4-5• Thinking:high