Skip to main content

org

Parameters

Configuration for the default organizations. This is expected to be a list of objects containing the following parameters:

ParameterTypeDescription
handlestringthe organization handle, e.g. git@github.com:XaF, github.com/XaF
trustedbooleanwhether or not the organization is to be trusted automatically for omni up (default: true)
worktreedirpathoverride the path to the worktree for that organization, see worktree (default: null)
repo_path_formatstringoverride the format string for the path to the repository, see repo_path_format (default: null)

Example

org:
- handle: git@github.com:XaF
trusted: true
worktree: /home/xaf/my-stuff
repo_path_format: "%{repo}"
- handle: github.com/omnicli
trusted: true

Environment

The environment variable OMNI_ORG can be used to add organizations as a comma-separated list. Any organization added through the OMNI_ORG environment variable will be automatically trusted, and will prepend the configuration list of organizations. The worktree can be specified for each organization by appending =<worktree> to each entry in the environment variable. e.g.

export OMNI_ORG=git@github.com:XaF=/home/xaf/my-stuff,github.com/omnicli