Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 016f2b9

Browse files
committedMar 15, 2025·
tmp
1 parent 98d1641 commit 016f2b9

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed
 

‎docs/src/freckles/cmd/root.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
> This can be prevented with [`CompletionOptions`].
1212
>
1313
> Historically [Cobra] had no dynamic completion and development in this regard was quite stale.
14-
> Without the burden of backward compability and the massive amount of [dependents], [Carapace] could develop much more quickly.
14+
> Without the burden of backward compability and the massive amount of [dependents],
15+
> [Carapace] could develop much more quickly and push the boundary of what's possible.
1516
>
1617
> Here's the [cornerstone] which ultimately became [Carapace].
1718
@@ -34,14 +35,23 @@ Most of these can be directly sourced.
3435

3536
![](./root/script.cast)
3637

37-
> [Carapace] has a basic shell detection mechanism, so in most cases `[shell]` is optional.
38+
> [Carapace] has a basic [shell detection] mechanism, so in most cases `[shell]` is optional.
3839
3940
## Export
4041

4142
Shell scripts in [Carapace] are just thin layers to integrate with the corresponding shell.
4243

43-
Aside from shell specific output (`freckles _carapace [shell] freckles ...[ARGS]`) which simplifies the shell scripts.
44-
[Export] provides a more generic `json` representation of completions.
44+
Aside from shell specific output (which simplifies the scripts):
45+
46+
```sh
47+
freckles _carapace [shell] freckles ...[ARGS]
48+
```
49+
50+
[Export] provides a more generic `json` representation of completions:
51+
52+
```sh
53+
freckles _carapace export freckles ...[ARGS]
54+
```
4555

4656
-
4757
-
@@ -74,3 +84,4 @@ Aside from shell specific output (`freckles _carapace [shell] freckles ...[ARGS]
7484
[MacroN]:https://pkg.go.dev/github.com/carapace-sh/carapace-spec#MacroN
7585
[Macros]:https://carapace-sh.github.io/carapace-spec/carapace-spec/macros.html
7686
[MacroV]:https://pkg.go.dev/github.com/carapace-sh/carapace-spec#MacroV
87+
[shell detection]:https://github.com/carapace-sh/carapace/blob/master/pkg/ps/ps.go

0 commit comments

Comments
 (0)
Please sign in to comment.