You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/instruction-files.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ mux supports **Scoped Instructions** that activate only in specific contexts. Yo
22
22
### General Rules
23
23
24
24
-**Precedence**: Workspace instructions (`<workspace>/AGENTS.md`) are checked first, then global instructions (`~/.mux/AGENTS.md`).
25
-
-**First Match Wins**: Only the *first* matching section found is used. Overriding global defaults is as simple as defining the same section in your workspace.
25
+
-**First Match Wins**: Only the _first_ matching section found is used. Overriding global defaults is as simple as defining the same section in your workspace.
26
26
-**Isolation**: These sections are **stripped** from the general `<custom-instructions>` block. Their content is injected only where it belongs (e.g., into a specific tool's description or a special XML tag).
27
27
-**Boundaries**: A section's content includes everything until the next heading of the same or higher level.
28
28
@@ -38,19 +38,24 @@ Use mode-specific sections to optimize context and customize behavior for specif
38
38
39
39
```markdown
40
40
# General Instructions
41
+
41
42
- Be concise
42
43
43
44
## Mode: Plan
45
+
44
46
When planning:
47
+
45
48
- Focus on goals and trade-offs
46
49
- Propose alternatives with pros/cons
47
50
48
51
## Mode: Compact
52
+
49
53
- Preserve key decisions
50
54
- Be extremely concise
51
55
```
52
56
53
57
**Available modes**:
58
+
54
59
-**exec** (default) — Normal operations.
55
60
-**plan** — Active in Plan Mode.
56
61
-**compact** — Used during `/compact` to guide history summarization.
@@ -60,16 +65,19 @@ When planning:
60
65
Scope instructions to specific models or families using regex matching. The matched content is injected via a `<model-...>` tag.
61
66
62
67
**Syntax**: `Model: <regex>`
68
+
63
69
- Regexes are case-insensitive by default.
64
70
- Use `/pattern/flags` for custom flags (e.g., `/openai:.*codex/i`).
65
71
66
72
**Example**:
67
73
68
74
```markdown
69
75
## Model: sonnet
76
+
70
77
Be terse and to the point.
71
78
72
-
## Model: openai:.*codex
79
+
## Model: openai:.\*codex
80
+
73
81
Use status reporting tools every few minutes.
74
82
```
75
83
@@ -78,19 +86,23 @@ Use status reporting tools every few minutes.
78
86
Customize how the AI uses specific tools by appending instructions to their descriptions.
79
87
80
88
**Syntax**: `Tool: <tool_name>`
89
+
81
90
- Tool names must match exactly (case-insensitive).
82
91
- Only tools available for the active model are augmented.
0 commit comments