stackage-cli 0.0.0 → 0.0.0.1

raw patch · 4 files changed

+59/−2 lines, 4 filesnew-uploader

Files

• ChangeLog.md +7/−0
• README.md +49/−0
• main/Sandbox.hs +1/−1
• stackage-cli.cabal +2/−1

@@ -0,0 +1,7 @@+## 0.0.0.1++* Compilation fix for GHC 7.10 [#29](https://github.com/fpco/stackage-cli/issues/29)++## 0.0.0++* Initial release

@@ -0,0 +1,49 @@+stackage-cli+============++A command-line interface for leveraging stackage.++You must have `ghc`, `ghc-pkg`, and `cabal` on your $PATH. This program will make various calls to those executables on your behalf.++This package provides a number of executables. Primary among these is the `stackage` executable (and its alias `stk`). The `stackage` command-line program will inspect your path for stackage plugins, and will dispatch to them. Anything on your $PATH prefixed `stackage-` that responds to the `--summary` flag is considered a stackage plugin.++(This package also provides a library, `Stackage.CLI`, which is intended to make the process of writing stackage plugins easier.)++This package provides the following stackage plugins:++## stackage init++Downloads a `cabal.config` file from `stackage.org`. That's all it does! The `cabal.config` file constrains the package versions used to build your project. Stackage.org is constantly calculating the best compatible build plans for a big subset of Hackage.++## stackage purge++Calls `ghc-pkg unregister` on your package databases. (You will be prompted on a per-db basis; use `stackage purge --force` if you don't want to be prompted.) This is an easy way to clean out your sandbox.++## stackage upgrade++A `stackage purge` followed by `stackage init`.++## stackage sandbox++The sandbox plugin has a few commands of its own that mirror the above three stackage commands:++### stackage sandbox init++In addition to downloading a `cabal.config` file, this will also set up a shared sandbox (via `cabal.sandbox.config`) corresponding to whatever stackage snapshot is used. By default, the latest available Stackage LTS snapshot will be used.++Shared sandboxes are located at `$HOME/.stackage/sandboxes`. Be aware! Anything you `cabal install` to this sandbox will be available to any other projects that share the same sandbox. The `cabal.config` file should help make sure you don't install anything incompatible.++### stackage sandbox delete++Delete `cabal.config` and `cabal.sandbox.config`.++Unlike `stackage purge`, this does not alter any package databases. The shared sandbox will remain untouched. You can use `stackage sandbox delete NAME` to delete the shared sandbox called NAME (e.g. lts-2.0) from your system.++### stackage sandbox upgrade++Replace `cabal.config` and `cabal.sandbox.config` with newer versions and (possibly) a new shared sandbox.+++## Further reading++See also: [this example on the stackage-cli wiki](https://github.com/fpco/stackage-cli/wiki/Example).

@@ -318,7 +318,7 @@     Nothing -> do       putStrLn "Notice: Your old sandbox remains intact:"       T.putStrLn db-    Just db' -> case T.takeWhile (not . flip elem "/\\") db' of+    Just db' -> case T.takeWhile (not . flip elem ("/\\" :: String)) db' of       snapshot | not (T.null snapshot) -> do         T.putStrLn $ "Notice: The " <> snapshot <> " shared sandbox remains intact."         T.putStrLn $ "You may delete it from your system by calling:"

@@ -1,5 +1,5 @@ name:                stackage-cli-version:             0.0.0+version:             0.0.0.1 synopsis:   A CLI library for stackage commands description:@@ -12,6 +12,7 @@ build-type:          Simple cabal-version:       >=1.10 category: Development+extra-source-files:  README.md ChangeLog.md  library   hs-source-dirs: src/