Idris2Doc : Pack.Runner.Install

Pack.Runner.Install

(source)

Definitions

packagePathDirs : HasIO io => Env -> EitherT PackErr io DirList
  Directories to be listed in the `IDRIS2_PACKAGE_PATH` variable, so
that Idris finds all libraries installed by pack in custom locations.

Totality: total
Visibility: export
packageLibDirs : HasIO io => Env -> EitherT PackErr io DirList
  Directories to be listed in the `IDRIS2_LIBS` variable, so
that Idris finds all `.so` files installed by pack in custom locations.

Totality: total
Visibility: export
packageDataDirs : HasIO io => Env -> EitherT PackErr io DirList
  Directories to be listed in the `IDRIS2_DATA` variable, so
that Idris finds all support files installed by pack in custom locations.

Totality: total
Visibility: export
packagePath : HasIO io => Env => EitherT PackErr io EnvVar
  `IDRIS2_PACKAGE_PATH` variable to be used with Idris, so
that it finds all libraries installed by pack in custom locations.

Totality: total
Visibility: export
libPath : HasIO io => Env => EitherT PackErr io EnvVar
  `IDRIS2_LIBS` variable to be used with Idris, so
that it finds all `.so` files installed by pack in custom locations.

Totality: total
Visibility: export
dataPath : HasIO io => Env => EitherT PackErr io EnvVar
  `IDRIS2_DATA` variable to be used with Idris, so
that it finds all support files installed by pack in custom locations.

Totality: total
Visibility: export
buildEnv : HasIO io => Env => EitherT PackErr io (List EnvVar)
  This unifies `packagePath`, `libPath` and `dataPath`,
to generate an environment necessary to build packages with Idris
the dependencies of which are handled by pack.

Totality: total
Visibility: export
idrisWithPkg : HasIO io => IdrisEnv => ResolvedLib t -> EitherT PackErr io (CmdArgList, List EnvVar)
  Idris executable loading the given package plus the
environment variables needed to run it.

Totality: total
Visibility: export
idrisWithPkgs : HasIO io => IdrisEnv => List (ResolvedLib t) -> EitherT PackErr io (CmdArgList, List EnvVar)
  Idris executable loading the given packages plus the
environment variables needed to run it.

Totality: total
Visibility: export
ipkgCodeGen : Env => PkgDesc -> Codegen
Totality: total
Visibility: export
checkBuildDir : HasIO io => IdrisEnv => Desc Safe -> EitherT PackErr io ()
  Check if the build directory associated with the given `.ipkg` file
is outdated, either because it does not contain an `.idrisVersion` file,
or because this file has a different commit tag than the Idris version
we use currently.

Visibility: export
libPkg : HasIO io => IdrisEnv => List EnvVar -> LogLevel -> Bool -> CmdArgList -> Desc Safe -> EitherT PackErr io ()
  Use the installed Idris to run an operation on
a library `.ipkg` file.

Visibility: export
mkIdris : HasIO io => Env => EitherT PackErr io IdrisEnv
  Builds and installs the Idris commit given in the environment.

Visibility: export
install : HasIO io => IdrisEnv => List (InstallType, PkgName) -> EitherT PackErr io ()
  Install the given list of libraries or applications, by first
resolving each of them and then creating a build plan including
all dependencies of the lot.

Visibility: export
installLibs : HasIO io => IdrisEnv => List PkgName -> EitherT PackErr io ()
  Install the given list of libraries, by first
resolving each of them and then creating a build plan including
all dependencies of the lot.

Visibility: export
installApps : HasIO io => IdrisEnv => List PkgName -> EitherT PackErr io ()
  Install the given list of applications, by first
resolving each of them and then creating a build plan including
all dependencies of the lot.

Visibility: export
installDeps : HasIO io => IdrisEnv => Desc Safe -> EitherT PackErr io ()
  Install the (possibly transitive) dependencies of the given
loaded `.ipkg` file.

Visibility: export
idrisEnv : HasIO io => PackDirs => TmpDir => LibCache => LineBufferingCmd => MetaConfig -> FetchMethod -> EitherT PackErr io IdrisEnv
  Creates a packaging environment with Idris2 installed.

Visibility: export
update : HasIO io => IdrisEnv -> EitherT PackErr io ()
  Update the pack installation

Visibility: export
Fixity Declaration: infixl operator, level 7
remove : HasIO io => Env => List (PkgType, PkgName) -> EitherT PackErr io ()
  Remove the given libs or apps

Visibility: export
removeLibs : HasIO io => Env => List PkgName -> EitherT PackErr io ()
  Remove the given libs

Visibility: export
removeApps : HasIO io => Env => List PkgName -> EitherT PackErr io ()
  Remove the given apps

Visibility: export