API Documentation

start()

Starts AutoSysimages package. It's usually called by start.jl file; but it can be called manually as well.

latest_sysimage()

Return the path to the latest system image produced by AutoSysimages, or nothing if no such image exits.

julia_args()

Get Julia arguments for running AutoSysimages:

• "-J [sysimage]" - sets the latest_sysimage(), if it exits,
• "-L [@__DIR__]/start.jl" - starts AutoSysimages automatically.

build_sysimage(background::Bool = false)

Build new system image (in background) for the current project including snooped precompiles.

remove_old_sysimages()

Remove old sysimages for the current project (active_dir()).

packages_to_include()::Set{String}

Get list of packages to be included into sysimage. It is determined based on "include" or "exclude" options save by Preferences.jl in LocalPreferences.toml file next to the currently-active project. Notice dev packages are excluded unless they are in include list.

select_packages()

Ask the user to choose which packages to include into the sysimage.

status()

Print list of packages to be included into sysimage determined by packages_to_include.

add(package::String)

Set package to be included into the system image.

remove(package::String)

Set package to be excluded into the system image.

active_dir()

Get directory where the sysimage and precompiles are stored for the current project. The directory is created if it doesn't exist yet.

preferences_path()

Get the file with preferences for the active project (active_dir()). Preferences are stored in SysimagePreferences.toml next to the current Project.toml file.

install()

This install the asysimg scripts. (Currently implemented only for Linux.)