Two files, one repository
FutureExcited/vibe-rules ships 5 formats across 6 indexed files. The question worth asking is whether the second one says anything the first does not.
| Dimension | Shared | Only in A | Only in B | Overlap |
|---|---|---|---|---|
| Sections | 0 | 5 | 1 | 0% |
| Commands | 0 | 0 | 0 | — |
| Section tags | 2 | 2 | 0 | 50% |
What each file covers
Sections
0 shared · 5 only in A · 1 only in B- − CODEX Agent Configuration
- − Codex File Hierarchy
- − Custom Project Rules
- − Rule Examples
- − Additional Notes
- + Claude Code AI Rules
Commands
neither file has anySection tags
2 shared · 2 only in A · 0 only in B- − testing-strategy
- − docs
- do-not
- agent-behaviour
Line diff
FutureExcited/vibe-rules · reference/codex-rules-directory/AGENTS.md
@@ −1 @@
1# CODEX Agent Configuration
2
3This file demonstrates how `vibe-rules` formats and manages rules for the CODEX editor. Rules are stored as XML-like tagged blocks within a `<vibe-rules Integration>` section.
4
5## Codex File Hierarchy
6
7Codex looks for AGENTS.md files in the following places and merges them top-down:
8
91. `~/.codex/AGENTS.md` - personal global guidance (use `--global` flag)
102. `AGENTS.md` at repo root - shared project notes (default behavior)
113. `AGENTS.md` in current working directory - sub-folder/feature specifics (use `--target` flag)
12
13## Custom Project Rules
14
15Add your custom CODEX rules here...
16
17## Rule Examples
18
19<!-- vibe-rules Integration -->
20<react-component-patterns>
21React Component Development Guidelines
22
23Always Apply: true
24Globs: src/components/**/\*.tsx, src/components/**/\*.jsx
25
26When creating React components:
27
281. Use functional components with hooks instead of class components
292. Implement proper TypeScript interfaces for props
303. Use descriptive component and prop names
314. Extract complex logic into custom hooks
325. Add proper JSDoc comments for complex components
336. Use React.memo() for performance optimization when appropriate
347. Implement proper error boundaries for critical components
35 </react-component-patterns>
36
37<api-design-patterns>
38API Development Best Practices
39
40Always Apply: false
41Globs: src/api/**/\*.ts, src/routes/**/\*.ts
42
43For API development:
44
451. Use consistent REST conventions (GET, POST, PUT, DELETE)
462. Implement proper error handling with meaningful HTTP status codes
473. Use middleware for authentication and validation
484. Document APIs with OpenAPI/Swagger specifications
495. Implement rate limiting and request validation
506. Use proper TypeScript types for request/response objects
517. Add comprehensive logging for debugging
52 </api-design-patterns>
53
54<testing-guidelines>
55Testing and Quality Assurance
56
57Always Apply: true
58
59Testing best practices:
60
611. Write unit tests for all business logic functions
622. Use integration tests for API endpoints
633. Implement end-to-end tests for critical user flows
644. Maintain at least 80% code coverage
655. Use descriptive test names that explain the scenario
666. Mock external dependencies appropriately
677. Test both success and error cases
688. Use factories or fixtures for test data setup
69 </testing-guidelines>
70
71<architecture-patterns>
72Software Architecture Guidelines
73
74Globs: src/models/**/\*.ts, src/services/**/_.ts, src/utils/\*\*/_.ts
75
76Architecture principles:
77
781. Follow SOLID principles in class design
792. Use dependency injection for better testability
803. Implement proper separation of concerns
814. Use design patterns appropriately (Factory, Strategy, Observer)
825. Keep functions small and focused on single responsibility
836. Implement proper error handling and logging
847. Use TypeScript interfaces to define contracts
858. Follow consistent naming conventions
86</architecture-patterns>
87<!-- /vibe-rules Integration -->
88
89## Additional Notes
90
91The CODEX editor reads agent instructions from `AGENTS.md` files. The hierarchy allows for flexible configuration:
92
93- Global rules apply to all projects
94- Project-root rules apply to the entire project
95- Directory-specific rules apply to current working directory contexts
96
97Rules managed by `vibe-rules` are contained within the `<!-- vibe-rules Integration -->` comment block to distinguish them from manually added rules.
98
99Rules can include metadata such as:
100
101- **Always Apply**: Whether the rule should be automatically applied to all relevant contexts
102- **Globs**: File patterns that determine when the rule should be active
103
104Use `vibe-rules` commands to manage these rules:
105
106- `vibe-rules save my-rule -f ./my-rule.md` - Save a rule to local storage
107- `vibe-rules load my-rule codex` - Apply a saved rule to this file
108- `vibe-rules load my-rule codex --global` - Apply to global `~/.codex/AGENTS.md`
109- `vibe-rules load my-rule codex --target ./subdir/AGENTS.md` - Apply to specific directory
110- `vibe-rules install codex` - Install rules from NPM packages with `llms` exports
111
FutureExcited/vibe-rules · reference/claude-code-directory/CLAUDE.md
@@ +1 @@
1# Claude Code AI Rules
2
3This file contains AI rules for Claude Code IDE. Rules are managed by vibe-rules and stored in XML-like tagged blocks.
4
5<!-- vibe-rules Integration -->
6
7<always-on>
8Always Apply: true - This rule should ALWAYS be applied by the AI
9
10Always do this
11</always-on>
12
13<glob>
14Always Apply: false - This rule should only be applied when relevant files are open
15Always apply this rule in these files: src/**/*.ts, package.json
16
17do this when editing files matching the glob
18</glob>
19
20<manual>
21do things when this rule is mentioned
22</manual>
23
24<model-decision>
25description for when the rule can be applied
26
27do this when the description matches the current task
28</model-decision>
29
30<!-- /vibe-rules Integration -->
31
@@ −1 +1 @@
1−# CODEX Agent Configuration
1+# Claude Code AI Rules
22
3−This file demonstrates how `vibe-rules` formats and manages rules for the CODEX editor. Rules are stored as XML-like tagged blocks within a `<vibe-rules Integration>` section.
3+This file contains AI rules for Claude Code IDE. Rules are managed by vibe-rules and stored in XML-like tagged blocks.
44
5−## Codex File Hierarchy
6−
7−Codex looks for AGENTS.md files in the following places and merges them top-down:
8−
9−1. `~/.codex/AGENTS.md` - personal global guidance (use `--global` flag)
10−2. `AGENTS.md` at repo root - shared project notes (default behavior)
11−3. `AGENTS.md` in current working directory - sub-folder/feature specifics (use `--target` flag)
12−
13−## Custom Project Rules
14−
15−Add your custom CODEX rules here...
16−
17−## Rule Examples
18−
195 <!-- vibe-rules Integration -->
20−<react-component-patterns>
21−React Component Development Guidelines
226
23−Always Apply: true
24−Globs: src/components/**/\*.tsx, src/components/**/\*.jsx
7+<always-on>
8+Always Apply: true - This rule should ALWAYS be applied by the AI
259
26−When creating React components:
10+Always do this
11+</always-on>
2712
28−1. Use functional components with hooks instead of class components
29−2. Implement proper TypeScript interfaces for props
30−3. Use descriptive component and prop names
31−4. Extract complex logic into custom hooks
32−5. Add proper JSDoc comments for complex components
33−6. Use React.memo() for performance optimization when appropriate
34−7. Implement proper error boundaries for critical components
35− </react-component-patterns>
13+<glob>
14+Always Apply: false - This rule should only be applied when relevant files are open
15+Always apply this rule in these files: src/**/*.ts, package.json
3616
37−<api-design-patterns>
38−API Development Best Practices
17+do this when editing files matching the glob
18+</glob>
3919
40−Always Apply: false
41−Globs: src/api/**/\*.ts, src/routes/**/\*.ts
20+<manual>
21+do things when this rule is mentioned
22+</manual>
4223
43−For API development:
24+<model-decision>
25+description for when the rule can be applied
4426
45−1. Use consistent REST conventions (GET, POST, PUT, DELETE)
46−2. Implement proper error handling with meaningful HTTP status codes
47−3. Use middleware for authentication and validation
48−4. Document APIs with OpenAPI/Swagger specifications
49−5. Implement rate limiting and request validation
50−6. Use proper TypeScript types for request/response objects
51−7. Add comprehensive logging for debugging
52− </api-design-patterns>
27+do this when the description matches the current task
28+</model-decision>
5329
54−<testing-guidelines>
55−Testing and Quality Assurance
56−
57−Always Apply: true
58−
59−Testing best practices:
60−
61−1. Write unit tests for all business logic functions
62−2. Use integration tests for API endpoints
63−3. Implement end-to-end tests for critical user flows
64−4. Maintain at least 80% code coverage
65−5. Use descriptive test names that explain the scenario
66−6. Mock external dependencies appropriately
67−7. Test both success and error cases
68−8. Use factories or fixtures for test data setup
69− </testing-guidelines>
70−
71−<architecture-patterns>
72−Software Architecture Guidelines
73−
74−Globs: src/models/**/\*.ts, src/services/**/_.ts, src/utils/\*\*/_.ts
75−
76−Architecture principles:
77−
78−1. Follow SOLID principles in class design
79−2. Use dependency injection for better testability
80−3. Implement proper separation of concerns
81−4. Use design patterns appropriately (Factory, Strategy, Observer)
82−5. Keep functions small and focused on single responsibility
83−6. Implement proper error handling and logging
84−7. Use TypeScript interfaces to define contracts
85−8. Follow consistent naming conventions
86−</architecture-patterns>
8730 <!-- /vibe-rules Integration -->
88−
89−## Additional Notes
90−
91−The CODEX editor reads agent instructions from `AGENTS.md` files. The hierarchy allows for flexible configuration:
92−
93−- Global rules apply to all projects
94−- Project-root rules apply to the entire project
95−- Directory-specific rules apply to current working directory contexts
96−
97−Rules managed by `vibe-rules` are contained within the `<!-- vibe-rules Integration -->` comment block to distinguish them from manually added rules.
98−
99−Rules can include metadata such as:
100−
101−- **Always Apply**: Whether the rule should be automatically applied to all relevant contexts
102−- **Globs**: File patterns that determine when the rule should be active
103−
104−Use `vibe-rules` commands to manage these rules:
105−
106−- `vibe-rules save my-rule -f ./my-rule.md` - Save a rule to local storage
107−- `vibe-rules load my-rule codex` - Apply a saved rule to this file
108−- `vibe-rules load my-rule codex --global` - Apply to global `~/.codex/AGENTS.md`
109−- `vibe-rules load my-rule codex --target ./subdir/AGENTS.md` - Apply to specific directory
110−- `vibe-rules install codex` - Install rules from NPM packages with `llms` exports
11131
