git.iko.soy/haskell.nix
on wineTestWrapperWithPath help sign in
haskell.nix/docs/reference/commands.md
80 lines 2.8 kB history raw
1# stack-to-nix
3```
4stack-to-nix - a stack to nix converter
6Usage: stack-to-nix (-o|--output DIR) [--stack-yaml FILE]
7 [--ignore-package-yaml] [--cache FILE]
8 Generate a Nix expression for a Haskell package using Stack
10Available options:
11 -o,--output DIR Generate output in DIR
12 --stack-yaml FILE Override project stack.yaml (default: "stack.yaml")
13 --ignore-package-yaml disable hpack run and use only cabal disregarding
14 package.yaml existence
15 --cache FILE Dependency cache
16 file (default: ".stack-to-nix.cache")
17 -h,--help Show this help text
18```
20Use this for stack projects. If a `default.nix` does not exist in the
21output directory, it will create a basic one with a
22[`mkStackPkgSet`](../user-guide/stack-projects.md) function.
24!!! note
25 If you find that there are missing files which should have been
26 generated, remove `.stack-to-nix.cache`
27 (The open issue is [#57][cache-issue]).
29[cache-issue]: https://github.com/input-output-hk/haskell.nix/issues/57
31# plan-to-nix
33```
34plan-to-nix - a stack to nix converter
36Usage: plan-to-nix (-o|--output DIR) [--plan-json FILE] [--cabal-project FILE]
37 [--cache FILE]
38 Generate a Nix expression for a Haskell package using Cabal
40Available options:
41 -o,--output DIR Generate output in DIR
42 --plan-json FILE Override plan.json
43 location (default: "dist-newstyle/cache/plan.json")
44 --cabal-project FILE Override path to
45 cabal.project (default: "cabal.project")
46 --cache FILE Dependency cache file (default: ".nix-tools.cache")
47 -h,--help Show this help text
48```
50Use this for Cabal new-build projects (even if you don't have a
51`cabal.project`). Before running, you need to create a plan. For more
52information, see [Cabal Projects](../user-guide/cabal-projects.md) in the user
53guide.
55It will create a template `default.nix` in the output directory,
56unless that file already exists.
58Inside the output directory, there will be another directory
59`.plan.nix`, which contains Nix expressions for all local packages,
60generated by `cabal-to-nix`. The output file `pkgs.nix` refers to
61these files.
63!!! note
64 If you find that there are missing files which should have been
65 generated, remove `.nix-tools.cache`
66 (The open issue is [#57][cache-issue]).
68# cabal-to-nix
70```
71Usage: cabal-to-nix FILE.cabal
72```
74This writes (to stdout) a [Haskell.nix][] Nix expression for the given
75cabal package.
77Normally, you do not need to run `cabal-to-nix` yourself. It is called
78by `stack-to-nix` and `plan-to-nix`.
80[haskell.nix]: https://github.com/input-output-hk/haskell.nix