Installing Orchestr8

Orchestr8 requires Python 3.9 or greater, and is tested on all major Python versions and operating systems.

pipuv

pip install orchestr8

uv pip install orchestr8

Upgrade to the latest released version at any time:

pipuv

pip install -U orchestr8

uv pip install -U orchestr8

Optional dependencies

Some components has their own dependencies that are not installed by default. If you wish to use all the components, you can install it through:

pipuv

pip install orchestr8[all]

uv pip install orchestr8[all]

If you wish to use particular components, you can install them by providing their module names as extra:

For the adapter module:

pipuv

pip install orchestr8[adapter]

uv pip install orchestr8[adapter]

For the execution-runtime module:

pipuv

pip install orchestr8[execution-runtime]

uv pip install orchestr8[execution-runtime]

For the sandbox-client module:

pipuv

pip install orchestr8[sandbox-client]

uv pip install orchestr8[sandbox-client]

For the shell module:

pipuv

pip install orchestr8[shell]

uv pip install orchestr8[shell]

Third party tool dependencies

Few components require third party tool dependencies to work. These tools must be installed separately.

• DirectoryTracker requires git for version control, you can download it from here
• OAuthFlow requires mkcert for setting up local redirect server, refer here for installation instructions
• SandboxClient, IsolatedShell and IsolatedRuntime depends on docker, refer here for installation instructions