Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Catalog

As a package manager, Orbit must know what packages are available and where packages are stored on your local file system so that they can be operated on. Orbit stores your projects in the catalog. The catalog is a set of directories on your local file system maintained by orbit. These directories are typically hidden from the user because they are not regularly interfacing with the file system contents at these locations and manually tampering the contents may cause trouble for Orbit when it tries to use them.

There are three levels to the catalog: the cache, the archive, and channels.

Cache

The cache maintains the projects that are currently installed on your local file system. Installed projects can be immediately added as a dependency to your current project.

Default location: $ORBIT_HOME/cache

Archive

The archive maintains the projects that are currently downloaded on your local file system. Downloaded projects can be added as a dependency to your current project only after being installed to the cache.

Default location: $ORBIT_HOME/archive

Channels

Channels are user-defined directories to set up as registries to maintain the projects that are currently available to download or install. These projects may require internet to download their contents and then install to your cache.

Default location: $ORBIT_HOME/channels

Adding a new channel is as simple as adding a directory to the location where channels are defined.