1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
<div class="hidden-warning"><a href="https://docs.haskellstack.org/"><img src="https://cdn.jsdelivr.net/gh/commercialhaskell/stack/doc/img/hidden-warning.svg"></a></div>
# The `stack exec` command
~~~text
stack exec COMMAND
[-- ARGUMENT(S) (e.g. stack exec ghc-pkg -- describe base)]
[--[no-]ghc-package-path] [--[no-]stack-exe] [--package PACKAGE]
[--rts-options RTSFLAG] [--cwd DIR]
~~~
`stack exec` executes the specified executable as a command in the Stack
environment. If an executable is not specified, the first argument after `--` is
taken to be the executable. Otherwise, all arguments after `--` are taken to be
command line arguments for the specified executable.
By default:
* the `GHC_PACKAGE_PATH` environment variable is set for the command's process.
Pass the flag `--no-ghc-package-path` to not set the environment variable;
* the `STACK_EXE` environment variable is set for the command's process. Pass
the flag `--no-stack-exe` to not set the environment variable; and
* the specified executable is executed in the current directory. Pass the option
`--cwd <directory>` to execute the executable in the specified directory.
The option `--package <package>` has no effect for the `stack exec` command. For
further information about its use, see the [`stack ghc` command](ghc_command.md)
documentation or the [`stack runghc` command](runghc_command.md) documentation.
Pass the option `--rts-option <rts_flag(s)>` to specify a GHC RTS flag or option.
The option can be specified multiple times. All specified GHC RTS flags and
options are added to the arguments for the specified executable between
arguments `+RTS` and `-RTS`.
Specified GHC RTS flags and options are separated by spaces. Items can be
unquoted (if they do not contain space or `"` characters) or quoted (`""`).
Quoted items can include 'escaped' characters, escaped with an initial `\`
character.
Account may need to be taken of the shell's approach to the processing of
command line arguments. For example, to pass `'a single quoted string'`:
=== "Unix-like (Bash or Zsh)"
In Bash, or Zsh (if `RC_QUOTES` option not set):
`stack exec <command> -- \''a single quoted string'\'`
Outside of single quotes, `\'` escapes a single quote. The content of single
quotes is taken literally, but cannot contain a single quote.
In Zsh (if `RC_QUOTES` option set):
`stack exec <command> -- '''a single quoted string'''`
The content of single quotes is taken literally. Within single quotes, `''`
escapes a single quote.
=== "Windows (PowerShell)"
`stack exec <command> -- '''a single quoted string'''`
The content of single quotes is taken literally. Within single quotes, `''`
escapes a single quote.
The command also accepts flags and options of the
[`stack build`](build_command.md#flags-affecting-ghcs-behaviour) command that
affect the location of the local project installation directory, such as
`--profile` and `--no-strip`. For further information, see the documentation of
the [project Stack work directory](stack_work.md#project-stack-work-directory).
|
