Skip to content

Commit 0870c65

Browse files
pashpashpashCline Evaluation
andauthored
moar docs (RooCodeInc#3689)
* title * crosslinking and commands * better * fixing * fixing inaccuracies * language * images --------- Co-authored-by: Cline Evaluation <[email protected]>
1 parent 36c0192 commit 0870c65

File tree

16 files changed

+720
-196
lines changed

16 files changed

+720
-196
lines changed

docs/docs.json

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,24 @@
7474
{
7575
"group": "Features",
7676
"pages": [
77-
"features/plan-and-act",
77+
"features/auto-approve",
78+
"features/checkpoints",
7879
"features/cline-rules",
80+
"features/drag-and-drop",
81+
"features/plan-and-act",
7982
"features/slash-commands/workflows",
83+
"features/editing-messages",
84+
{
85+
"group": "@ Mentions",
86+
"pages": [
87+
"features/at-mentions/overview",
88+
"features/at-mentions/file-mentions",
89+
"features/at-mentions/terminal-mentions",
90+
"features/at-mentions/problem-mentions",
91+
"features/at-mentions/git-mentions",
92+
"features/at-mentions/url-mentions"
93+
]
94+
},
8095
{
8196
"group": "Slash Commands",
8297
"pages": [
@@ -87,14 +102,13 @@
87102
]
88103
},
89104
{
90-
"group": "@ Mentions",
105+
"group": "Commands & Shortcuts",
91106
"pages": [
92-
"features/at-mentions/overview",
93-
"features/at-mentions/file-mentions",
94-
"features/at-mentions/terminal-mentions",
95-
"features/at-mentions/problem-mentions",
96-
"features/at-mentions/git-mentions",
97-
"features/at-mentions/url-mentions"
107+
"features/commands-and-shortcuts/overview",
108+
"features/commands-and-shortcuts/code-commands",
109+
"features/commands-and-shortcuts/terminal-integration",
110+
"features/commands-and-shortcuts/git-integration",
111+
"features/commands-and-shortcuts/keyboard-shortcuts"
98112
]
99113
}
100114
]
@@ -103,10 +117,8 @@
103117
"group": "Exploring Cline's Tools",
104118
"pages": [
105119
"exploring-clines-tools/cline-tools-guide",
106-
"exploring-clines-tools/checkpoints",
107120
"exploring-clines-tools/new-task-tool",
108-
"exploring-clines-tools/remote-browser-support",
109-
"exploring-clines-tools/slash-commands"
121+
"exploring-clines-tools/remote-browser-support"
110122
]
111123
},
112124
{

docs/exploring-clines-tools/checkpoints.mdx

Lines changed: 0 additions & 114 deletions
This file was deleted.

docs/exploring-clines-tools/new-task-tool.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ As a quick alternative to Cline suggesting the `newtask` tool or defining comple
2929
- **Action:** Cline will propose creating a new task, typically suggesting context based on the current session (similar to its default behavior when using the tool). You will still get the `ask_followup_question` prompt to confirm and potentially modify the context before the new task is created.
3030
- **Benefit:** Provides a fast, user-initiated way to leverage the `new_task` functionality for branching explorations or managing long sessions without waiting for Cline to suggest it.
3131

32+
<Note>
33+
For more details on using the `/newtask` slash command, see the [New Task Command](/features/slash-commands/new-task)
34+
documentation.
35+
</Note>
36+
3237
#### Default Behavior (Without `.clinerules`)
3338

3439
By default, without specific `.clinerules` dictating its behavior:

docs/exploring-clines-tools/slash-commands.mdx

Lines changed: 0 additions & 57 deletions
This file was deleted.

docs/features/at-mentions/overview.mdx

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "@ MentionsOverview"
2+
title: "@ Mentions Overview"
33
sidebarTitle: "Overview"
44
---
55

@@ -15,35 +15,45 @@ When you type `@` in the chat input, Cline shows a menu of available mention typ
1515

1616
Cline supports several types of @ mentions, each designed to bring different kinds of context into your conversations:
1717

18-
<Card title="File Mentions" icon="file" href="/features/at-mentions/file-mentions">
19-
Reference any file in your workspace with `@/path/to/file`. Cline sees the complete file content, including imports, related
20-
functions, and surrounding context.
21-
</Card>
18+
<Columns cols={2}>
19+
<Card title="File Mentions" icon="file" href="/features/at-mentions/file-mentions">
20+
Reference any file in your workspace with `@/path/to/file`. Cline sees the complete file content, including imports, related
21+
functions, and surrounding context.
22+
</Card>
23+
24+
{" "}
2225

2326
<Card title="Folder Mentions" icon="folder" href="/features/at-mentions/folder-mentions">
2427
Reference entire directories with `@/path/to/folder/`. Cline sees the folder structure and all file contents, perfect for
2528
understanding complex interactions between multiple files.
2629
</Card>
2730

31+
{" "}
32+
2833
<Card title="Problem Mentions" icon="triangle-exclamation" href="/features/at-mentions/problem-mentions">
2934
Use `@problems` to show Cline all the errors and warnings in your workspace. Cline sees the complete list with file locations
3035
and error messages.
3136
</Card>
3237

38+
{" "}
39+
3340
<Card title="Terminal Mentions" icon="terminal" href="/features/at-mentions/terminal-mentions">
3441
Use `@terminal` to share your recent terminal output. Cline sees the complete output with formatting preserved, perfect for
3542
debugging build errors or test failures.
3643
</Card>
3744

45+
{" "}
46+
3847
<Card title="Git Mentions" icon="code-branch" href="/features/at-mentions/git-mentions">
3948
Reference uncommitted changes with `@git-changes` or specific commits with `@[commit-hash]`. Cline sees the complete diff,
4049
commit message, and other relevant information.
4150
</Card>
4251

43-
<Card title="URL Mentions" icon="globe" href="/features/at-mentions/url-mentions">
44-
Reference web content with `@https://example.com`. Cline fetches and sees the complete webpage content, perfect for
45-
referencing documentation or GitHub issues.
46-
</Card>
52+
<Card title="URL Mentions" icon="globe" href="/features/at-mentions/url-mentions">
53+
Reference web content with `@https://example.com`. Cline fetches and sees the complete webpage content, perfect for
54+
referencing documentation or GitHub issues.
55+
</Card>
56+
</Columns>
4757

4858
## Why @ Mentions Matter
4959

docs/features/auto-approve.mdx

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
The Auto Approve menu lets you set fine-grained permissions on what you allow Cline to do in an automated way.
2+
3+
<Frame>
4+
<img src="https://storage.googleapis.com/cline_public_images/docs/assets/auto-approve.png" alt="Auto Approve" />
5+
</Frame>
6+
7+
## How it works
8+
9+
By default, Cline will ask for your permission before calling any tool, including reading or writing files.
10+
11+
If you want to allow Cline to do something without asking, you can set the Auto Approve permission for that tool.
12+
13+
## Permission Options
14+
15+
- **Read project files**
16+
17+
- Allows Cline to read files within your current workspace without asking
18+
- **Read all files**
19+
- Extends read permission to files outside your workspace (system files, config files, etc.)
20+
21+
- **Edit project files**
22+
23+
- Allows Cline to modify files within your current workspace without confirmation
24+
- **Edit all files**
25+
- Extends modification permission to files outside your workspace
26+
27+
- **Execute safe commands**
28+
29+
- Allows execution of terminal commands that the model deems non-destructive
30+
- **Execute all commands**
31+
- Permits execution of any terminal command without asking
32+
33+
- **Use the browser**
34+
35+
- Allows Cline to use the browser tool to fetch web content
36+
37+
- **Use MCP servers**
38+
39+
- Permits connection to and usage of MCP servers for extended functionality
40+
41+
- **Maximum requests**
42+
- Sets the number of consecutive automated actions Cline can take before requiring your input
43+
44+
## Best Practices
45+
46+
Personally, I like to keep auto-editing disabled because it gives me a chance to review changes every step of the way.
47+
48+
For most serious development workflows, I recommend starting with:
49+
50+
- Auto-approving read access to project files
51+
- Setting a reasonable maximum request limit (10-20)
52+
53+
This gives Cline enough freedom to explore your codebase without constant interruptions, while still requiring permission for edits or potentially destructive actions.
54+
55+
As you build more trust in Cline's capabilities with your specific projects, you can gradually increase the permissions to match your comfort level.
56+
57+
Remember that you can always adjust these settings as your needs change - tighten permissions for critical production work, or loosen them when prototyping and exploring.
58+
59+
You can even use the quick "star" actions to quickly toggle your auto-approved selections on and off as you go.

0 commit comments

Comments
 (0)