Skip to content

Commit f0c3e72

Browse files
authored
Merge pull request #5826 from mpilgrem/lsToolsDocs
Update master docs for `stack ls tools`
2 parents c45c924 + 0dd3e7b commit f0c3e72

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

doc/GUIDE_advanced.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,30 @@ The flag `--basic` specifies a more basic report, in the format that is accepted
8989
by Stack's command line option `--stack-colors` and the YAML configuration key
9090
`stack-colors`.
9191

92+
## The `stack ls tools` command
93+
94+
`stack ls tools` will list Stack's installed tools. On Unix-like operating
95+
systems, they will be one or more versions of GHC. On Windows, they will include
96+
MSYS2. For example, on Windows:
97+
98+
~~~
99+
$ stack ls tools
100+
ghc-9.4.1
101+
ghc-9.2.4
102+
ghc-9.0.2
103+
msys2-20210604
104+
~~~
105+
106+
The `--filter <tool_name>` option will filter the output by a tool name (e.g.
107+
'ghc', 'ghc-git' or 'msys2'). The tool name is case sensitive. For example:
108+
109+
~~~
110+
$ stack ls tools --filter ghc
111+
ghc-9.4.1
112+
ghc-9.2.4
113+
ghc-9.0.2
114+
~~~
115+
92116
## The `stack sdist` command
93117

94118
Hackage only accepts packages for uploading in a standard form, a compressed

0 commit comments

Comments
 (0)