Skip to content

Commit 902fdbd

Browse files
committed
docs: Update doc
1 parent 53c8dd5 commit 902fdbd

13 files changed

Lines changed: 1883 additions & 238 deletions

File tree

docs/docs/commands/add.md

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

docs/docs/commands/complete.md

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

docs/docs/commands/delete.md

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

docs/docs/commands/list.md

Lines changed: 58 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# pace list
22

3-
Display all your tasks.
3+
Display all available tasks, hooks, and aliases from your `config.pace` file.
44

55
## Usage
66

@@ -10,46 +10,84 @@ pace list [flags]
1010

1111
## Flags
1212

13-
- `--tree` - Display tasks in a tree view format (default: true)
13+
- `--tree`, `-t` - Display tasks in a tree view showing dependencies (default: false)
1414

1515
## Examples
1616

17-
### List all tasks (tree view)
17+
### List all tasks
1818

1919
```bash
2020
pace list
2121
```
2222

23-
### List all tasks with explicit tree flag
23+
Example output:
24+
```
25+
Available tasks:
26+
27+
build Build the application (default)
28+
test Run all tests
29+
deploy Deploy to production
30+
31+
Aliases:
32+
b -> build
33+
t -> test
34+
35+
Available hooks:
36+
format Format code
37+
lint Run linter
38+
```
39+
40+
### List with dependency tree
2441

2542
```bash
2643
pace list --tree
2744
```
2845

29-
### List without tree view
46+
Example output:
47+
```
48+
Task dependency tree:
49+
50+
build (default)
51+
├── test
52+
└── lint
53+
54+
deploy
55+
└── build
56+
├── test
57+
└── lint
58+
```
59+
60+
### Short flag version
3061

3162
```bash
32-
pace list --tree=false
63+
pace list -t
3364
```
3465

3566
## Output Format
3667

37-
### Tree View
68+
### Simple List (default)
3869

39-
When using tree view, tasks are displayed with:
40-
- Task ID
41-
- Completion status (✓ for completed)
42-
- Task name
70+
The default view shows three sections:
4371

44-
Example output:
45-
```
46-
├── [1] ✓ Task 1
47-
├── [2] Task 2
48-
└── [3] Task 3
49-
```
72+
1. **Available tasks**: All defined tasks with their descriptions
73+
- Tasks marked `(default)` will run when you execute `pace run` without arguments
74+
- If no description is provided, the command is shown instead
75+
76+
2. **Aliases**: Shortcuts to tasks (if any defined)
77+
78+
3. **Available hooks**: Reusable hooks that can be referenced by tasks
79+
80+
### Tree View
81+
82+
The tree view shows:
83+
- Task names with their dependencies
84+
- Visual tree structure showing the execution order
85+
- Default task indicator
86+
- Circular dependency detection (marked as "circular")
5087

5188
## Notes
5289

53-
- Completed tasks are marked with a checkmark (✓)
54-
- Tasks are displayed in the order they were added
55-
- The tree view provides a clean, visual representation of your task list
90+
- Tasks are displayed in alphabetical order
91+
- The default task is marked with `(default)`
92+
- Tree view helps visualize complex dependency chains
93+
- Circular dependencies are detected and marked to prevent infinite loops

0 commit comments

Comments
 (0)