File tree Expand file tree Collapse file tree 1 file changed +38
-0
lines changed Expand file tree Collapse file tree 1 file changed +38
-0
lines changed Original file line number Diff line number Diff line change @@ -43,3 +43,41 @@ Command Line Interface
43
43
Include the specified platform in the analysis.
44
44
May be specified multiple times.
45
45
If not specified, all platforms will be included.
46
+
47
+ Tree Tool
48
+ ---------
49
+
50
+ The tree tool generates a visualization of the code base where each file and
51
+ directory is annotated with information about platform usage and coverage.
52
+
53
+ .. code-block :: text
54
+
55
+ cbi-tree [-h] [--version] [-x <pattern>] [-p <platform>] [--prune] [-L <level>] <analysis-file>
56
+
57
+ **positional arguments: **
58
+
59
+ ``analysis-file ``
60
+ TOML file describing the analysis to be performed, including the codebase and platform descriptions.
61
+
62
+ **options: **
63
+
64
+ ``-h, --help ``
65
+ Display help message and exit.
66
+
67
+ ``--version ``
68
+ Display version information and exit.
69
+
70
+ ``-x <pattern>, --exclude <pattern> ``
71
+ Exclude files matching this pattern from the code base.
72
+ May be specified multiple times.
73
+
74
+ ``-p <platform>, --platform <platform> ``
75
+ Include the specified platform in the analysis.
76
+ May be specified multiple times.
77
+ If not specified, all platforms will be included.
78
+
79
+ ``--prune ``
80
+ Prune unused files from the tree.
81
+
82
+ ``-L <level>, --levels <level> ``
83
+ Print only the specified number of levels.
You can’t perform that action at this time.
0 commit comments