Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.osmosis.ai/llms.txt

Use this file to discover all available pages before exploring further.

Use onboarding once before running the quickstart or building a custom rollout. By the end, you should have a platform workspace, a connected GitHub repository, a local clone, and an authenticated CLI session. Osmosis setup starts in the Platform. The platform creates or provides a workspace repository on GitHub, and your local workspace directory is a clone of that repository.

Common Setup

Complete these steps before using Run the Multiply Example or Create Your Own Rollout.
1

Create or join a platform workspace

If you are creating a new workspace, sign in to the platform and create it there. If you were invited, accept the invitation and open the existing workspace.
2

Set up the workspace repository

Workspace owners or admins connect a GitHub account or organization, install the Osmosis GitHub App, and create the workspace repository from the platform.Repositories created from the platform include the starter examples multiply-local-strands, multiply-local-openai, and multiply-harbor-strands.Invited workspace members use the workspace repository that already exists. Do not create a second repository for the same workspace.
3

Clone the workspace repository

The platform shows clone commands once a repository is connected. Choose HTTPS, SSH, or GitHub CLI:
git clone https://github.com/<owner>/<repo>.git
cd <repo>
4

Install and authenticate the CLI

Install the Osmosis CLI and connect it to your account:
pip install osmosis-ai
osmosis auth login
Run platform commands from inside the workspace directory. The CLI reads GitHub origin to identify the platform workspace connected to this repository.
5

Verify local workspace context

From the cloned workspace directory, confirm the CLI can resolve your workspace:
osmosis doctor
osmosis auth whoami

Choose Your First Workflow

New to RL

Run the included multiply-local-openai example end to end with copy-paste commands.

Already have a task or dataset

Use the workspace’s project-local Agent Skills to plan training, create a rollout, and validate it locally.

Workspace Repository vs Directory

TermMeaning
Workspace repositoryThe GitHub repository connected to a platform workspace. The platform creates or connects it and uses it as the source of rollout code.
Workspace directoryYour local clone of the workspace repository. Run CLI commands from here so Osmosis can infer the connected workspace from Git origin.

If Setup Is Blocked

The platform may show a GitHub banner when the workspace is missing required repository setup.
StateWhat to do
No GitHub account connectedWorkspace owners or admins should connect GitHub from Git Integration.
No repository connectedWorkspace owners or admins should create or connect the workspace repository.
GitHub App disconnectedReconnect the GitHub App before submitting training.
Repository needs setupOpen Git Integration and follow the repository repair flow.
For details on how Git Sync controls the code version used for training, see Git Sync.

Next Steps

Run the Multiply Example

Copy and paste the shortest path from cloned repository to training.

Create Your Own Rollout

Build a task-specific rollout with project-local Agent Skills and local eval gates.

Workspace Repository

Understand how the CLI maps your Git clone to a platform workspace.