Skip to main content

.perpetual.toml

.perpetual.toml pins the endpoint, organization and space for every perpetual command run inside a repository.

endpoint = "https://app.example.com"
org_id = "ORG_ABC"
space_id = "SPC_ABC"

Every key is optional. The CLI warns about any other key and ignores it.

Where the CLI finds it​

The CLI looks for .perpetual.toml in the working directory, then in each parent directory in turn, and uses the first one it finds. --no-config skips the search.

The CLI ignores the file, with a warning, when it is a symlink or when another user owns it. A file owned by root is always trusted. A command run as root trusts a file whose owner also owns the working directory. Windows has no owner check.

Keys​

KeyValuePrecedence
endpointThe Perpetual URL to send requests to. It must use https, except on a loopback address (localhost, 127.0.0.1, or [::1]).A profile supplies the endpoint when one is in use. The CLI uses endpoint when no profile is, and fails with a CONFIG_ERROR when the active profile names a different endpoint.
org_idAn organization ID.--org-id, then PERPETUAL_ORG_ID, then org_id, then the profile's stored organization.
space_idA space ID, such as SPC_ABC.--space, then PERPETUAL_SPACE_ID, then space_id.

The CLI ignores space_id, with a warning, when org_id names an organization other than the one the command runs in.


Perpetual CLI 0.5.0