Skip to content

Commit d1280e2

Browse files
committed
Document stack ide commands
1 parent 6ec9fab commit d1280e2

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

doc/GUIDE_advanced.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,39 @@ If you'd like to get some insight into the dependency tree of your packages, you
1818
can use the `stack dot` command and Graphviz. More information is available in
1919
the [Dependency visualization](dependency_visualization.md) documentation.
2020

21+
## The `stack ide` commands
22+
23+
The `stack ide` commands provide information that may be of use in an
24+
integrated development environment (IDE). See `stack ide` for the available
25+
commands.
26+
27+
## The `stack ide packages` command
28+
29+
`stack ide packages` lists all available local packages that are loadable. By
30+
default, its output is sent to the standard error channel. This can be changed
31+
to the standard output channel with the `--stdout` flag.
32+
33+
By default, the output is the package name (without its version). This can be
34+
changed to the full path to the package's Cabal file with the `--cabal-files`
35+
flag.
36+
37+
## The `stack ide targets` command
38+
39+
`stack ide targets` lists all available Stack targets. By default, its output is
40+
sent to the standard error channel. This can be changed to the standard output
41+
channel with the `--stdout` flag.
42+
43+
For example, for the Stack project itself:
44+
45+
~~~
46+
$ cd stack
47+
$ stack ide targets
48+
stack:lib
49+
stack:exe:stack
50+
stack:exe:stack-integration-test
51+
stack:test:stack-test
52+
~~~
53+
2154
## The `stack list` command
2255

2356
`stack list [PACKAGE]...` list the version of the specified package(s) in a

0 commit comments

Comments
 (0)