spago-0.21.0

Safe Haskell | None
Language | Haskell2010

Spago.CLI

Synopsis

- data Command
  - = Default ShowVersion
  - | Migrate
  - | Init Force TemplateComments (Maybe Text)
  - | Install [PackageName]
  - | Sources
  - | ListPackages JsonFlag
  - | ListDeps JsonFlag IncludeTransitive
  - | BumpVersion DryRun VersionBump
  - | PackageSetUpgrade (Maybe Text)
  - | Freeze
  - | Search
  - | Path (Maybe PathType) BuildOptions
  - | Version
  - | Build BuildOptions
  - | Repl [PackageName] [SourcePath] [PursArg] DepsOnly PackageName
  - | Docs (Maybe DocsFormat) [SourcePath] DepsOnly NoSearch OpenDocs
  - | Run (Maybe ModuleName) BuildOptions [BackendArg]
  - | Script Text (Maybe Text) [PackageName] ScriptBuildOptions
  - | Test (Maybe ModuleName) BuildOptions [BackendArg]
  - | BundleModule WithMain BundleOptions BuildOptions
  - | Verify PackageName
  - | VerifySet CheckModulesUnique
  - | Bundle
  - | MakeModule
  - | ListPackagesOld
- echo :: MonadIO m => String -> m ()
- parser :: Parser (Command, GlobalOptions)
- options :: MonadIO io => Description -> Parser a -> io a

# Documentation

data Command #

Commands that this program handles

Constructors

Default ShowVersion | Default catch-all command
Migrate |
Init Force TemplateComments (Maybe Text) | Initialize a new project
Install [PackageName] | Install (download) dependencies defined in spago.dhall
Sources | Get source globs of dependencies in spago.dhall
ListPackages JsonFlag | List available packages
ListDeps JsonFlag IncludeTransitive | List dependencies of the project
BumpVersion DryRun VersionBump | Bump and tag a new version in preparation for release.
PackageSetUpgrade (Maybe Text) | Upgrade the package-set to the latest release
Freeze | Freeze the package-set so it will be cached
Search | Runs `purescript-docs-search search`.
Path (Maybe PathType) BuildOptions | Returns info about paths used by Spago
Version | Show version
Build BuildOptions | Build the project
Repl [PackageName] [SourcePath] [PursArg] DepsOnly PackageName | Start a REPL
Docs (Maybe DocsFormat) [SourcePath] DepsOnly NoSearch OpenDocs | Generate documentation for the project and its dependencies
Run (Maybe ModuleName) BuildOptions [BackendArg] | Run the project with some module, default Main
Script Text (Maybe Text) [PackageName] ScriptBuildOptions | Run the selected module as a script, specifying a .purs file, | optional package set tag, dependencies
Test (Maybe ModuleName) BuildOptions [BackendArg] | Test the project with some module, default Test.Main
BundleModule WithMain BundleOptions BuildOptions | Bundle a module into a CommonJS or ES module
Verify PackageName | Verify that a single package is consistent with the Package Set
VerifySet CheckModulesUnique | Verify that the Package Set is correct
Bundle | Bundle the project into an executable (replaced by BundleApp)
MakeModule | Bundle a module into a CommonJS module (replaced by BundleModule)
ListPackagesOld | List available packages (deprecated, old version of ListPackages)

echo :: MonadIO m => String -> m () #

parser :: Parser (Command, GlobalOptions) #

options :: MonadIO io => Description -> Parser a -> io a #

Parse the given options from the command line