Skip to main content

bootstrap

Bootstraps the configuration of omni

This will walk you through setting up the initial configuration to use omni, such as setting up the worktree, format to use when cloning repositories, and setting up initial organizations.

This command will be triggered automatically if no user-level configuration file is detected.

This command should be safe to call even with an existing configuration file. It will however override the specific configuration parameters with the new values set during the guided process.

Parameters

ParameterRequiredValue typeDescription
--worktreenonullBootstrap the main worktree location. If specified, only this and other specified bootstraps will be performed.
--repo-path-formatnonullBootstrap the repository path format. If specified, only this and other specified bootstraps will be performed.
--organizationsnonullBootstrap the organizations. If specified, only this and other specified bootstraps will be performed.
--shellnonullBootstrap the shell integration. If specified, only this and other specified bootstraps will be performed.

Examples

# Starts the bootstrap process
omni config bootstrap

# Only bootstrap the worktree
omni config bootstrap --worktree

# Bootstrap the worktree and organizations
omni config bootstrap --worktree --organizations

# Bootstrap the shell integration
omni config bootstrap --shell