summaryrefslogtreecommitdiff
path: root/research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/Pkg/docs/src/api.md
diff options
context:
space:
mode:
authorYurenHao0426 <blackhao0426@gmail.com>2026-06-13 12:35:36 -0500
committerYurenHao0426 <blackhao0426@gmail.com>2026-06-13 12:35:36 -0500
commit66e0d8b9fd4d0f7a2231d689c055e26fdf1cf04a (patch)
treec29cba61124018755a19b02c9d33e3ad5f2e05cc /research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/Pkg/docs/src/api.md
rrm workspace: TRM/HRM/SRM code, Maze dataset, dynamical-analysis pipelineHEADmain
Curated export for clone-and-run Maze training (2x A6000) + diagnostics. trm/hrm pretrain.py carry trajectory-augmentation code (backward-compatible). Heavy artifacts (checkpoints/wandb/npz) gitignored; see PROVENANCE.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Diffstat (limited to 'research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/Pkg/docs/src/api.md')
-rw-r--r--research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/Pkg/docs/src/api.md88
1 files changed, 88 insertions, 0 deletions
diff --git a/research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/Pkg/docs/src/api.md b/research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/Pkg/docs/src/api.md
new file mode 100644
index 0000000..29a54c4
--- /dev/null
+++ b/research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/Pkg/docs/src/api.md
@@ -0,0 +1,88 @@
+# [**12.** API Reference](@id API-Reference)
+
+This section describes the function interface, or "API mode",
+for interacting with Pkg.jl. The function API is recommended
+for non-interactive usage, for example in scripts.
+
+## General API Reference
+
+Certain options are generally useful and can be specified in any API call.
+You can specify these options by setting keyword arguments.
+
+### Redirecting output
+
+Use the `io::IOBuffer` keyword argument to redirect Pkg output.
+For example, `Pkg.add("Example"; io=devnull)` will discard any output produced by the `add` call.
+
+## Package API Reference
+
+In the REPL mode, packages (with associated version, UUID, URL etc) are parsed from strings,
+for example `"Package#master"`,`"Package@v0.1"`, `"www.mypkg.com/MyPkg#my/feature"`.
+
+In the API mode, it is possible to use strings as arguments for simple commands (like `Pkg.add(["PackageA", "PackageB"])`,
+but more complicated commands, which e.g. specify URLs or version range, require the use of a more structured format over strings.
+This is done by creating an instance of [`PackageSpec`](@ref) which is passed in to functions.
+
+```@docs
+PackageSpec
+PackageMode
+UpgradeLevel
+Pkg.add
+Pkg.develop
+Pkg.activate
+Pkg.rm
+Pkg.update
+Pkg.test
+Pkg.build
+Pkg.pin
+Pkg.free
+Pkg.instantiate
+Pkg.resolve
+Pkg.gc
+Pkg.status
+Pkg.precompile
+Pkg.offline
+Pkg.setprotocol!
+Pkg.dependencies
+Pkg.project
+Pkg.undo
+Pkg.redo
+```
+
+
+## Registry API Reference
+
+!!! compat "Julia 1.1"
+ Pkg's registry handling requires at least Julia 1.1.
+
+The function API for registries uses [`RegistrySpec`](@ref)s, similar to
+[`PackageSpec`](@ref).
+
+```@docs
+RegistrySpec
+Pkg.Registry.add
+Pkg.Registry.rm
+Pkg.Registry.update
+Pkg.Registry.status
+```
+
+## [Artifacts API Reference](@id Artifacts-Reference)
+
+!!! compat "Julia 1.3"
+ Pkg's artifacts API requires at least Julia 1.3.
+
+```@docs
+Pkg.Artifacts.create_artifact
+Pkg.Artifacts.remove_artifact
+Pkg.Artifacts.verify_artifact
+Pkg.Artifacts.artifact_meta
+Pkg.Artifacts.artifact_hash
+Pkg.Artifacts.bind_artifact!
+Pkg.Artifacts.unbind_artifact!
+Pkg.Artifacts.download_artifact
+Pkg.Artifacts.find_artifacts_toml
+Pkg.Artifacts.ensure_artifact_installed
+Pkg.Artifacts.ensure_all_artifacts_installed
+Pkg.Artifacts.@artifact_str
+Pkg.Artifacts.archive_artifact
+```