Cline rules

1---
2description: Guidelines for creating standardized Cline workflow files
3author: Community
4version: 1.0
5category: "Workflow"
6tags: ["workflow", "guidelines", "documentation", "task-automation"]
7globs: [".clinerules/workflows/**/*.md"]
8---
9 
10## Brief overview
11This document provides guidelines for creating standardized Cline workflow files. Workflows are stored in the `.clinerules/workflows` directory and follow a specific structure to ensure consistency and proper execution.
12 
13## Workflow file structure
14- All workflow files must be placed in the `.clinerules/workflows` directory
15- Files should be named descriptively with kebab-case (e.g., `generate-trace-report-by-workitem.md`)
16- It is recommended to create workflows for common, multi-step tasks to promote automation and consistency.
17- Each workflow must be enclosed in `<task>` tags with a `name` attribute
18- The task objective must be enclosed in `<task_objective>` tags
19- The detailed sequence steps must be enclosed in `<detailed_sequence_steps>` tags
20- The entire workflow should follow proper markdown formatting conventions
21 
22## Task definition
23- Begin each workflow file with `<task name="Descriptive Task Name">`
24- End each workflow file with `</task>`
25- The task name should be concise but descriptive of the workflow's purpose
26- Example: `<task name="Generate Trace Report by Workitem">`
27 
28## Task objective
29- The task objective section should be enclosed in `<task_objective>` tags
30- Provide a clear, concise description of what the workflow aims to accomplish
31- Include any key tools or resources that will be used (e.g., MCP tools)
32- Specify the expected output format (e.g., markdown file)
33- Keep the objective to 1-3 sentences for clarity
34 
35## Detailed sequence steps
36- The detailed steps section should be enclosed in `<detailed_sequence_steps>` tags
37- Begin with a level 1 heading that includes the workflow name and "Process - Detailed Sequence of Steps"
38- Organize major steps as level 2 headings (##) with sequential numbering
39- Use numbered lists for substeps under each major step
40- Indent sublists by 4 spaces
41- Surround all headings with newlines for proper formatting
42- Surround all code blocks with newlines
43 
44## Tool usage conventions
45- Explicitly reference tools using backticks (e.g., `ask_followup_question`)
46- For user interaction, use the `ask_followup_question` tool
47- For accessing external data, use appropriate MCP tools (e.g., `use_mcp_tool`)
48- For file operations, specify directory checks and file creation steps
49- Always end workflows with the `attempt_completion` tool to present results
50 
51## Step formatting
52- Major steps should follow a logical sequence
53- Each major step should have a clear purpose
54- Substeps should provide specific actions to take
55- Include examples where helpful (e.g., example IDs, formats)
56- For output generation steps, clearly specify:
57  - Directory structure and creation
58  - File naming conventions
59  - Content structure with detailed subsections
60 
61## Example workflow structure
62```markdown
63<task name="Example Workflow">
64 
65<task_objective>
66Brief description of what this workflow accomplishes and its output.
67</task_objective>
68 
69<detailed_sequence_steps>
70# Example Workflow Process - Detailed Sequence of Steps
71 
72## 1. First Major Step
73 
741. First substep with specific action.
75   
762. Second substep with specific action.
77 
78## 2. Second Major Step
79 
801. First substep with specific action.
81   
822. Second substep with specific action.
83   - Additional detail or example
84 
85## 3. Generate Output
86 
871. Organize outputs under the root directory outputs/ 
88 
892. Check if output directory exists, create if needed.
90 
913. Create output file with specified content:
92   i. First content section
93   ii. Second content section
94   iii. Third content section
95 
964. Use the `attempt_completion` command to present results.
97 
98</detailed_sequence_steps>
99 
100</task>
101 
102## Available Tools
103 
104**General Cline Tools:**
105 
106- **execute_command**: Execute CLI commands on the system
107- **read_file**: Read the contents of a file
108- **write_to_file**: Create new files or overwrite existing ones
109- **replace_in_file**: Make targeted edits to specific parts of a file
110- **search_files**: Perform regex searches across files in a directory
111- **list_files**: List files and directories within a specified directory
112- **list_code_definition_names**: List definition names in source code files
113- **browser_action**: Interact with a Puppeteer-controlled browser
114- **ask_followup_question**: Ask the user for additional information
115- **attempt_completion**: Present the result of completed work
116- **new_task**: Create a new task with preloaded context
117- **plan_mode_respond**: Respond to user inquiries in PLAN MODE
118- **load_mcp_documentation**: Load documentation about creating MCP servers
119 
120```