feat: Add project_rules.md and user_rules.md support with CLI management functionality #298
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
Fix TypeError in ModelConfig dataclass where non-default arguments followed default arguments. The issue occurred because 'max_tokens' (with default value None) was positioned before required parameters like 'temperature', 'top_p', 'top_k', 'parallel_tool_calls', and 'max_retries' which have no default values. Python dataclasses require all parameters without default values to be declared before parameters with default values. Changes: - Moved required parameters (temperature, top_p, top_k, parallel_tool_calls, max_retries) to the beginning of the dataclass - Moved optional parameters (max_tokens, supports_tool_calling, etc.) after required ones Fixes the CLI startup error: "TypeError: non-default argument 'temperature' follows default argument"
- Add load_project_rules() method to safely load rules from project directory - Add format_rules_for_prompt() method to format rules for system prompts - Add validate_rules_file() method with enhanced validation: * Limit file size to 10,000 characters * Validate file contains only text content (no binary/control characters) * Ensure UTF-8 encoding compatibility - Include security checks to prevent path traversal attacks - Support both absolute and relative file paths This enables the agent to dynamically load project-specific rules and guidelines from Project_rules.md files, enhancing customization capabilities.
Implement user personal coding rules feature, allowing developers to create personal coding preference files Main changes: - Extend TraeAgentConfig class, add user_rules_enabled and user_rules_path configuration options - Enhance ProjectRulesLoader class, add load_user_rules and load_combined_rules methods - Modify TraeAgent class to support loading both project rules and user rules simultaneously - Refactor _get_project_rules method to use combined rules functionality - Update configuration example file trae_config.yaml.example - Create user_rules.md.example template file - Update .gitignore to ignore personal user rules files Features: - Support independent enable/disable of project rules and user rules - Automatically merge project rules and user rules - User rules files are not version controlled, protecting personal preference privacy - Provide complete configuration examples and usage templates Affected files: - trae_agent/utils/config.py - trae_agent/utils/project_rules.py - trae_agent/agent/trae_agent.py - trae_config.yaml.example - .gitignore - user_rules.md.example (new)
… user_rules.md command-line operations feat: add CLI rules management functionality for project_rules.md and user_rules.md command-line operations New Features: - Implement RulesManager class providing comprehensive rule file management functionality - Add rules command group with 6 subcommands: list, add, remove, update, add-section, remove-section - Support unified management of project rules (project_rules.md) and user rules (user_rules.md) - Integrate permission validation and error handling mechanisms Main Changes: - Added: trae_agent/utils/rules_manager.py - Core rule management class - Modified: trae_agent/cli.py - Added rules command group and all subcommands Command Usage: - trae rules list [project|user] - View rule content - trae rules add [project|user] SECTION RULE - Add new rules - trae rules remove [project|user] SECTION RULE - Remove rules - trae rules update [project|user] SECTION OLD_RULE NEW_RULE - Update rules - trae rules add-section [project|user] SECTION - Add new sections - trae rules remove-section [project|user] SECTION - Remove sections Security Features: - Directory write permission validation - File path security checks - Graceful error handling with user-friendly error messages Test Coverage: - All CRUD operations have passed functional tests - Permission validation and error handling verified - Support for custom working directory parameters
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.
Feature: Project Rules and User Rules Support
Overview
This PR adds comprehensive support for
project_rules.mdanduser_rules.mdfiles, bringing trae-agent in line with the main Trae functionality and addressing issues mentioned in #293.Motivation
###Core Functionality
project_rules.md): Project-wide coding standards and conventionsuser_rules.md): Personal coding preferences and habits###CLI Management Tools
New
trae rulescommand group with comprehensive subcommands:list [project|user]- View current rulesadd [project|user] SECTION RULE- Add new rulesremove [project|user] SECTION RULE- Remove existing rulesupdate [project|user] SECTION OLD_RULE NEW_RULE- Update rulesadd-section [project|user] SECTION- Create new rule sectionsremove-section [project|user] SECTION- Delete rule sectionsTechnical Implementation
Files Added/Modified
trae_agent/utils/rules_manager.py- Core rule management functionalitytrae_agent/cli.py- CLI command integrationtrae_agent/utils/config.py- Configuration supporttrae_agent/utils/project_rules.py- Enhanced rule loadingtrae_agent/agent/trae_agent.py- Agent integrationuser_rules.md.example- User rule template.gitignore- Ignore personal user rulesKey Features
--working-diroptionUsage Examples
Related Issues
Documentation
This PR provides code reference and solution for Project_rules.md related problems mentioned in #293