Project rules
Project rules are stored in.kombai/rules
. Monorepos can include separate ./kombai/rules
directories for each project. Project rules allow you to enforce crucial project-specific instructions like naming conventions, folder structure, and internationalization.
Examples of project rules:
- Generate new UI components only inside
src/ui/components/
and route files only insidesrc/app/routes/
. - All visible text must be sourced from a translation system, not hard-coded strings.
User rules
User rules are global instructions defined in your system’s home directory (~/.kombai/rules/
). They allow you to enforce instructions you want to apply across all your projects.
Examples of user rules:
- Always respond in Turkish. Write all the texts and alt-texts used in the code in Turkish.
Only the LLM responses will be in the specified language. The rest of the tool’s interface will remain in English.
- Use a default dark theme on all new components and pages.
Nesting in rules
Rules can be nested in the./kombai/rules
directory. This lets you organize the rules across multiple files and folders within the ./kombai/rules
.
AGENTS.md
AGENTS.md
is a generic rule file for AI agents. Use it as an alternative to .kombai/rules
. It can be global or local to a project.
Kombai automatically picks up the AGENTS.md
file stored in the project. For global instructions, create an AGENTS.md
file in your system’s home directory (~/AGENTS.md
) and enter the path via Manage rules.
Manage rules
Rules can be managed through the Manage rules modal. Kombai automatically picks up any rule file stored in the project. You can also create or delete rules through Manage rules or add a path to your existing AGENTS.md file.Create a rule
Manage rules supports the creation of Project rules or User rules. To create a rule:- Click in the input box.
- Under Project Rules or User Rules, enter the name of the file you want to delete.
- Click the button.
Delete a rule
Manage rules supports the deletion of Project rules or User rules. To delete a project rule:- Click in the input box.
- Under Project Rules, enter the name of the file you want to delete.
- Click the .
Modify a rule
Manage rules supports the modification of all rule files. To modify a rule:- Click in the input box.
- Click besides the rule file that you want to modify.
- Edit the new opened rule file.
- Save the file.
Add rule path
Rule path can be added forAGENTS.md
. Add the path to your global AGENTS.md
file stored in your system’s home directory.
To add path to your AGENTS.md
:
- Click in the input box.
- Click Add your AGENTS.md.
- Click the button.