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.

The Osmosis CLI is organized into two groups:
  • Workflow Commandsdataset, train, model, eval, rollout, init
  • Platform Commandsauth, workspace, upgrade
Run osmosis -h to see all available commands. Every sub-command supports -h / --help for detailed usage.

init

Initialize a new local Osmosis workspace directory with the standard project layout.
osmosis init <name> [--here]
Argument / OptionTypeDescription
namestr (required)Workspace name (used for directory name and config)
--hereflagInitialize in current directory instead of creating a subdirectory
# Create a new workspace in a subdirectory
osmosis init my-project

# Initialize the current directory as a workspace
osmosis init my-project --here
See Workspace Overview for details on the generated directory structure.

dataset

Manage datasets — upload, list, preview, validate, and delete.

dataset upload

Upload a dataset file to the active workspace.
osmosis dataset upload <file>
ArgumentTypeDescription
filestr (required)Path to the file to upload (CSV, JSONL, or Parquet; max 5 GB)
osmosis dataset upload data/train.jsonl

dataset list

List datasets in the active workspace.
osmosis dataset list [--limit N] [--all]
OptionTypeDefaultDescription
--limitint50Maximum number of datasets to show
--allflagShow all datasets
--all and --limit are mutually exclusive.

dataset status

Check the processing status of a dataset.
osmosis dataset status <name>
ArgumentTypeDescription
namestr (required)Dataset name

dataset preview

Preview rows from a dataset.
osmosis dataset preview <name> [--rows N]
Argument / OptionTypeDefaultDescription
namestr (required)Dataset name
--rowsint5Number of rows to show
osmosis dataset preview my-dataset --rows 10

dataset validate

Validate a dataset file locally without uploading.
osmosis dataset validate <file>
ArgumentTypeDescription
filestr (required)Path to the file to validate

dataset delete

Delete a dataset from the active workspace.
osmosis dataset delete <name> [--yes]
Argument / OptionTypeDescription
namestr (required)Dataset name
-y, --yesflagSkip confirmation prompt

train

Manage training runs — submit, monitor, export metrics, stop, and delete.

train submit

Submit a new training run from a TOML configuration file.
osmosis train submit <config_path> [--yes]
Argument / OptionTypeDescription
config_pathpath (required)Path to training config TOML file
-y, --yesflagSkip confirmation prompt
osmosis train submit configs/training/default.toml
See Configuration Files for the full TOML schema.
The training run executes rollout code from your Git Sync’d repository, not your local workspace. Commit and push before submitting, or pin the run to a specific revision with commit_sha in your training config.

train list

List training runs in the active workspace.
osmosis train list [--limit N] [--all]
OptionTypeDefaultDescription
--limitint50Maximum number of runs to show
--allflagShow all training runs
--all and --limit are mutually exclusive.

train status

Show details of a specific training run.
osmosis train status <name>
ArgumentTypeDescription
namestr (required)Training run name

train metrics

Export training run metrics to a JSON file. Displays a summary table and metric trend graphs in the terminal.
osmosis train metrics <name> [--output PATH]
Argument / OptionTypeDefaultDescription
namestr (required)Training run name
-o, --outputstr.osmosis/metrics/Output path. A trailing / or existing directory generates a default filename inside it. Non-.json extensions are replaced.
# Export to default location (.osmosis/metrics/)
osmosis train metrics my-run

# Export to a specific file
osmosis train metrics my-run -o results/my-run.json

train stop

Stop a running training run.
osmosis train stop <name> [--yes]
Argument / OptionTypeDescription
namestr (required)Training run name
-y, --yesflagSkip confirmation prompt

train delete

Delete a training run and all associated data.
osmosis train delete <name> [--yes]
Argument / OptionTypeDescription
namestr (required)Training run name
-y, --yesflagSkip confirmation prompt
Deleting a training run permanently removes all metrics, logs, and checkpoints. This cannot be undone.

model

Manage models — list, delete, and upcoming deploy/export/build operations.

model list

List models in the active workspace.
osmosis model list [--limit N] [--all]
OptionTypeDefaultDescription
--limitint50Maximum number of models to show
--allflagShow all models

model delete

Delete a model from the active workspace.
osmosis model delete <name> [--yes]
Argument / OptionTypeDescription
namestr (required)Model path (e.g. google/gemma-2-9b-it)
-y, --yesflagSkip confirmation prompt
You cannot delete a model that has active training runs depending on it. Delete those training runs first.

model deploy / model export / model build

osmosis model deploy
osmosis model export
osmosis model build
These commands are coming soon and are not yet functional. They are registered as placeholders in the CLI.

rollout

List rollouts synced from your workspace to the Osmosis platform.

rollout list

List rollouts in the active workspace.
osmosis rollout list [--limit N] [--all]
OptionTypeDefaultDescription
--limitint50Maximum number of rollouts to show
--allflagShow all rollouts

eval

Evaluate agents against datasets — run evaluations, use LLM-as-judge rubrics, and manage the eval cache.

eval run

Evaluate an agent against a dataset using a TOML configuration file.
osmosis eval run <config_path> [options]
Argument / OptionTypeDefaultDescription
config_pathstr (required)Path to eval TOML config file
--freshflagDiscard cached results and re-run all rows
--retry-failedflagRe-run only previously failed rows
--limitintall rowsMax rows to evaluate
--offsetint0Skip first N rows
-q, --quietflagSuppress progress output
--debugflagEnable debug logging and execution tracing
-o, --output-pathstrOverride structured output directory
--log-samplesflagSave full conversation logs to JSONL
--batch-sizeintfrom configOverride concurrent batch size
# Run full evaluation
osmosis eval run configs/eval/default.toml

# Re-run only failed rows with debug output
osmosis eval run configs/eval/default.toml --retry-failed --debug
See Configuration Files and Local Evaluation for more details.

eval rubric

Run LLM-as-judge evaluation: score conversations against a rubric using any LiteLLM-compatible model.
osmosis eval rubric [options]
Required options:
OptionTypeDescription
-d, --datastrPath to JSONL file with conversations
-r, --rubricstrRubric text (inline string) or @file.txt to read from a file
--modelstrJudge model in LiteLLM format (e.g. openai/gpt-5.2)
Optional:
OptionTypeDefaultDescription
-n, --numberint1Number of evaluation runs per record
-o, --outputstrPath to write evaluation results as JSON
--api-keystrAPI key for the judge model
--timeoutfloatRequest timeout in seconds
--score-minfloat0.0Minimum score value
--score-maxfloat1.0Maximum score value
# Inline rubric
osmosis eval rubric \
  -d data/conversations.jsonl \
  -r "Score the response on accuracy and completeness" \
  --model openai/gpt-5.2

# Rubric from file
osmosis eval rubric \
  -d data/conversations.jsonl \
  -r @rubrics/accuracy.txt \
  --model openai/gpt-5.2 \
  -o results/rubric-scores.json

eval cache dir

Print the eval cache root directory path.
osmosis eval cache dir

eval cache ls

List cached evaluations with optional filters.
osmosis eval cache ls [--model STR] [--dataset STR] [--status STR]
OptionTypeDescription
--modelstrFilter by model name
--datasetstrFilter by dataset path
--statusstrFilter by status: in_progress or completed

eval cache rm

Remove cached evaluations.
osmosis eval cache rm [task_id] [options]
Argument / OptionTypeDescription
task_idstr (optional)Task ID of a specific cache entry to delete
--allflagDelete all cached evaluations
--modelstrFilter by model name
--datasetstrFilter by dataset path
--statusstrFilter by status: in_progress or completed
-y, --yesflagSkip confirmation prompt
# Remove a specific cached eval
osmosis eval cache rm abc123

# Remove all cached evals for a specific model
osmosis eval cache rm --model openai/gpt-5.2 --yes

auth

Manage authentication. See Installation & Authentication for full details.
CommandDescription
osmosis auth loginAuthenticate via browser OAuth or token
osmosis auth logoutRevoke session and clear credentials
osmosis auth whoamiShow current user and active workspace

workspace

Manage platform workspaces. See Installation & Authentication for full details.
CommandDescription
osmosis workspaceInteractive TUI for browsing workspace contents
osmosis workspace listList available workspaces
osmosis workspace create <name>Create a new workspace
osmosis workspace switch <name>Switch active workspace
osmosis workspace delete <name>Delete a workspace

upgrade

Self-upgrade the CLI to the latest version published on PyPI.
osmosis upgrade
Auto-detects your install method (pip, pipx, or uv tool) and runs the appropriate upgrade command. Displays the currently installed version and the latest available version before upgrading.