Create and maintain local registries for Julia packages. This package is intended to provide a simple workflow for maintaining local registries (private or public) without making any assumptions about how the registry or the packages are hosted.
For registration in the General registry, see Registrator.
For serving local packages through a Package Server see the companion package LocalPackageServer.
This package requires Julia 1.1 or later.
You need to have command line
git installed and available in the
in the Julia REPL prints a version number rather than giving an error, you are good to go.
using Pkg pkg"add LocalRegistry"
using LocalRegistry create_registry(name, repository_url, description = "My private registry")
This prepares a registry with the given name in the standard
location for registries. Review the result and
git push it
manually. When created in this way the registry is automatically
activated and the next section can be skipped.
The registry can also be created at a specified path. See the documentation string for details.
To activate the registry, do
using Pkg pkg"registry add <repository url>"
This only needs to be done once per Julia installation.
Register a Package
using LocalRegistry register(package, registry = registry)
Register the new
package in the registry
registry. The version
number and other information is obtained from the package's
Project.toml. The easiest way to specify
by name as strings. See the documentation string for more options.
- You need to have a clean working copy of your registry.
- The package must be stored as a git working copy, e.g. having been
- The package must be available in the current
- The package must have a
- There is no checking that the dependencies are available in any registry.
- If you have exactly one installed registry beside the
Generalregistry, it is not necessary to specify
Register a New Version of a Package
using LocalRegistry register(package)
When adding a new version of a package, the registry can be
omitted. The new version number is obtained from the
of the package's
Simplified Registration of Active Package
If you start Julia with the
--project flag or use
activate a developed package, this package can be registered simply by
using LocalRegistry register()
This is also sufficient for registering a new package, provided that
you have exactly one installed registry beside the