Configurations

Application

Application build configurations.

Keywords

• path: application build path, default is "build".
• incremental: set to true to build incrementally, default is true.
• filter_stdlibs: set to true to filter out unused stdlibs, default is false.
• cpu_target: cpu target to build, default is PackageCompiler.default_app_cpu_target().
• precompile: precompile configurations, see Precompile, default is Precompile().
• c_driver_program: driver program.

Command

Configs for Command execution.

Keywords

• color: whether print with color in help page, default is true.
• static: whether genrate help info at compile time, the format won't be adaptive to displaysize anymore, if true, default is true.
• width: if static=true, width is used to set the static size of expected terminal.
• dash: whether parse -- seperator, default is true.
• plugin: parse <main CLI name>-<plugin> for CLI plugin, default is false.

Comonicon

Build configurations for Comonicon. One can set this option via Comonicon.toml under the root path of a Julia project directory and read in using read_configs.

Keywords

• name: required, the name of CLI file to install.
• command: configs for command parsing.
• install: installation options, see also Install.
• sysimg: system image build options, see also SysImg.
• download: download options, see also Download.
• application: application build options, see also Application.

Download

Download information.

Keywords

• host: where are the tarballs hosted, default is "github.com"
• user: required, user name on the host.
• repo: required, repo name on the host.

Install

Installation configurations.

Keywords

• path: installation path.
• completion: set to true to install shell auto-completion scripts.
• quiet: print logs or not, default is false.
• compile: julia compiler option for CLIs if not built as standalone application, default is "min". See help section of julia --compile for more details.
• optimize: julia compiler option for CLIs if not built as standalone application, default is 2. See help section of julia --optimize for more details.
• nthreads: julia compiler option for CLIs if not built as standalone application, default is 1.

Precompile

Precompilation files for PackageCompiler.

Keywords

• execution_file: precompile execution file.
• statements_file: precompile statements file.

SysImg

System image build configurations.

Keywords

• path: system image path to generate into, default is "deps/lib".
• incremental: set to true to build incrementally, default is true.
• filter_stdlibs: set to true to filter out unused stdlibs, default is false.
• cpu_target: cpu target to build, default is PackageCompiler.default_app_cpu_target().
• precompile: precompile configurations, see Precompile, default is Precompile().

find_comonicon_toml(path::String, files=["Comonicon.toml", "JuliaComonicon.toml"])

Find Comonicon.toml or JuliaComonicon.toml in given path.

read_options(comonicon; kwargs...)

Read in Comonicon build options. The argument comonicon can be:

• a module of a Comonicon CLI project.
• a path to a Comonicon CLI project that contains either JuliaComonicon.toml or Comonicon.toml.
• a path to a Comonicon CLI build configuration file named either JuliaComonicon.toml or Comonicon.toml.

In some cases, you might want to change the configuration written in the TOML file temporarily, e.g for writing build tests etc. In this case, you can modify the configuration using corresponding keyword arguments.

keyword arguments of Application and SysImg are the same, thus keys like filter_stdlibs are considered ambiguous in read_options, but you can specifiy them by specifiy the specific Application or SysImg object, e.g

read_options(MyCLI; sysimg=SysImg(filter_stdlibs=false))

See also Comonicon, Install, SysImg, Application, Download, Precompile.

read_toml(mod::Module)

Read Comonicon.toml or JuliaComonicon.toml in given module's project path.

read_toml(path::String)

Read Comonicon.toml or JuliaComonicon.toml in given path.