Skip to content

Commit 0fc2627

Browse files
committed
docs: update quick-start guide with detailed file command examples and format specifications.
1 parent 362a7ea commit 0fc2627

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/devins/quick-start.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,14 @@ ScreenShot
2424

2525
## Basic Commands
2626

27-
- `/file`: read file content
27+
- `/file`: read file content, format: `/file:<file-path>`, example: `/file:src/main/java/com/example/Controller.java`.
2828
- `/write`: write file content, format: `file#L1-L12`, example: `src/main/java/com/example/Controller.java#L1-L12`
29-
- `/rev`: read git change by git revision
30-
- `/run`: run code
31-
- `/patch`: apply patches to file
29+
- `/rev`: read git change by git revision.
30+
- `/run`: run code, especially for test file, which is the best way to run code.
31+
- `/patch`: apply patches to file.
3232
- `/commit`: commit changes to git
33-
- `/symbol`: get child by symbol, like get Class by package name, format: `java.lang.String#length`, example: `<package>.<class>#<method>`
33+
- `/symbol`: get child by symbol, like get Class by package name, format: `java.lang.String#length`,
34+
example: `<package>.<class>#<method>`
3435

3536
### File Command
3637

@@ -72,7 +73,7 @@ Get child elements by symbol, like get Class by package name.
7273
/symbol:cc.unitmesh.untitled.demo
7374

7475
The output will be:
75-
76+
7677
```java
7778
cc.unitmesh.untitled.demo.MathHelper
7879
cc.unitmesh.untitled.demo.DemoApplication

0 commit comments

Comments
 (0)