Concepts

Workspaces

Maps an Exo projects to a directory on your filesystem. Most projects have one workspace rooted at the same directory as their checked out code. This is how exo knows what project you're working on based on your current working directory.

If run in an unmapped directory, exo gui will offer to create a workspace for you. You can determine the current workspace with exo workspace, initialize a new one with exo init or delete the current workspace with exo workspace destroy.

Manifests

A file describing all of the components in a project. In addition to Exo's prefered exo.hcl format, Exo also supports procfiles and compose files. Use exo apply ./path/to/manifest whenever your manifest changes to make your workspace match. Components will be added or removed accordingly.

Components

An abstract definition of resources managed by exo. Presently, the only supported type of components are processes. Each component has a unique name within a workspace. Components are manipulated by applying manifests (see below), or with CRUD operations such as exo ls, exo new, and exo rm.

Resources

Resources are the underlying stateful entities managed by components. Usually, there is a one-to-one relationship a component and its managed resource. The distinction matters for some future scenerios, such as zero-downtime deployments.

Daemon

A background service that manages components and supervises processes. Most commands start this service automatically. You can start it explicitly with exo daemon and terminate it with exo exit.

Last updated