Starting with Julia 1.6, the artifacts support has moved fromPkg.jl
to Julia itself. Until proper documentation can be added here, you can learn more about artifacts in thePkg.jl
manual athttps://julialang.github.io/Pkg.jl/v1/artifacts/.
Julia's artifacts API requires at least Julia 1.6. In Julia versions 1.3 to 1.5, you can usePkg.Artifacts
instead.
Artifacts.artifact_meta
—Functionartifact_meta(name::String, artifacts_toml::String; platform::AbstractPlatform = HostPlatform(), pkg_uuid::Union{Base.UUID,Nothing}=nothing)
Get metadata about a given artifact (identified by name) stored within the given(Julia)Artifacts.toml
file. If the artifact is platform-specific, useplatform
to choose the most appropriate mapping. If none is found, returnnothing
.
This function requires at least Julia 1.3.
Artifacts.artifact_hash
—Functionartifact_hash(name::String, artifacts_toml::String; platform::AbstractPlatform = HostPlatform())
Thin wrapper aroundartifact_meta()
to return the hash of the specified, platform- collapsed artifact. Returnsnothing
if no mapping can be found.
This function requires at least Julia 1.3.
Artifacts.find_artifacts_toml
—Functionfind_artifacts_toml(path::String)
Given the path to a.jl
file, (such as the one returned by__source__.file
in a macro context), find the(Julia)Artifacts.toml
that is contained within the containing project (if it exists), otherwise returnnothing
.
This function requires at least Julia 1.3.
Artifacts.@artifact_str
—Macromacro artifact_str(name)
Return the on-disk path to an artifact. Automatically looks the artifact up by name in the project's(Julia)Artifacts.toml
file. Throws an error on if the requested artifact is not present. If run in the REPL, searches for the toml file starting in the current directory, seefind_artifacts_toml()
for more.
If the artifact is marked "lazy" and the package hasusing LazyArtifacts
defined, the artifact will be downloaded on-demand withPkg
the first time this macro tries to compute the path. The files will then be left installed locally for later.
Ifname
contains a forward or backward slash, all elements after the first slash will be taken to be path names indexing into the artifact, allowing for an easy one-liner to access a single file/directory within an artifact. Example:
ffmpeg_path = @artifact"FFMPEG/bin/ffmpeg"
This macro requires at least Julia 1.3.
Slash-indexing requires at least Julia 1.6.
Artifacts.artifact_exists
—Functionartifact_exists(hash::SHA1; honor_overrides::Bool=true)
Return whether or not the given artifact (identified by its sha1 git tree hash) exists on-disk. Note that it is possible that the given artifact exists in multiple locations (e.g. within multiple depots).
This function requires at least Julia 1.3.
Artifacts.artifact_path
—Functionartifact_path(hash::SHA1; honor_overrides::Bool=true)
Given an artifact (identified by SHA1 git tree hash), return its installation path. If the artifact does not exist, returns the location it would be installed to.
This function requires at least Julia 1.3.
Artifacts.select_downloadable_artifacts
—Functionselect_downloadable_artifacts(artifacts_toml::String; platform = HostPlatform, include_lazy = false, pkg_uuid = nothing)
Return a dictionary where every entry is an artifact from the givenArtifacts.toml
that should be downloaded for the requested platform. Lazy artifacts are included ifinclude_lazy
is set.
Settings
This document was generated withDocumenter.jl version 1.8.0 onWednesday 9 July 2025. Using Julia version 1.11.6.