跳转到主要内容

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.

Osmosis CLI 分为两组命令：
  • 工作流命令 — dataset、train、model、eval、rollout、init
  • 平台命令 — auth、workspace、upgrade
运行 osmosis -h 查看所有可用命令。每个子命令都支持 -h / --help 获取详细用法。

​
init

初始化一个新的本地 Osmosis 工作空间目录，使用标准项目布局。 
osmosis init <name> [--here]
参数 / 选项类型说明
namestr（必填）工作空间名称（用于目录名和配置）
--hereflag在当前目录中初始化，而不是创建子目录
# 在子目录中创建新工作空间
osmosis init my-project

# 将当前目录初始化为工作空间
osmosis init my-project --here
详情请参阅工作空间概览了解生成的目录结构。

​
dataset

管理数据集 — 上传、列出、预览、验证和删除。

​
dataset upload

将数据集文件上传到活跃工作空间。 
osmosis dataset upload <file>
参数类型说明
filestr（必填）要上传的文件路径（CSV、JSONL 或 Parquet；最大 5 GB）
osmosis dataset upload data/train.jsonl

​
dataset list

列出活跃工作空间中的数据集。 
osmosis dataset list [--limit N] [--all]
选项类型默认值说明
--limitint50显示的最大数据集数量
--allflag—显示所有数据集
--all 和 --limit 互斥。

​
dataset status

检查数据集的处理状态。 
osmosis dataset status <name>
参数类型说明
namestr（必填）数据集名称

​
dataset preview

预览数据集中的行。 
osmosis dataset preview <name> [--rows N]
参数 / 选项类型默认值说明
namestr（必填）—数据集名称
--rowsint5显示的行数
osmosis dataset preview my-dataset --rows 10

​
dataset validate

在本地验证数据集文件，无需上传。 
osmosis dataset validate <file>
参数类型说明
filestr（必填）要验证的文件路径

​
dataset delete

从活跃工作空间删除数据集。 
osmosis dataset delete <name> [--yes]
参数 / 选项类型说明
namestr（必填）数据集名称
-y, --yesflag跳过确认提示

​
train

管理训练任务 — 提交、监控、导出指标、停止和删除。

​
train submit

从 TOML 配置文件提交新的训练任务。 
osmosis train submit <config_path> [--yes]
参数 / 选项类型说明
config_pathpath（必填）训练配置 TOML 文件的路径
-y, --yesflag跳过确认提示
osmosis train submit configs/training/default.toml
完整 TOML 配置格式请参阅配置文件。
训练任务执行的是您**Git Sync 过来的仓库**中的 rollout 代码，而不是本地工作区中的代码。提交前请先 commit 并 push，或者在训练配置中用 commit_sha 将本次运行固定到特定版本。

​
train list

列出活跃工作空间中的训练任务。 
osmosis train list [--limit N] [--all]
选项类型默认值说明
--limitint50显示的最大训练任务数量
--allflag—显示所有训练任务
--all 和 --limit 互斥。

​
train status

显示特定训练任务的详细信息。 
osmosis train status <name>
参数类型说明
namestr（必填）训练任务名称

​
train metrics

将训练任务指标导出为 JSON 文件。在终端中显示摘要表格和指标趋势图。 
osmosis train metrics <name> [--output PATH]
参数 / 选项类型默认值说明
namestr（必填）—训练任务名称
-o, --outputstr.osmosis/metrics/输出路径。末尾带 / 或指向已有目录时，会在其中生成默认文件名。非 .json 扩展名会被替换。
# 导出到默认位置（.osmosis/metrics/）
osmosis train metrics my-run

# 导出到指定文件
osmosis train metrics my-run -o results/my-run.json

​
train stop

停止正在运行的训练任务。 
osmosis train stop <name> [--yes]
参数 / 选项类型说明
namestr（必填）训练任务名称
-y, --yesflag跳过确认提示

​
train delete

删除训练任务及所有关联数据。 
osmosis train delete <name> [--yes]
参数 / 选项类型说明
namestr（必填）训练任务名称
-y, --yesflag跳过确认提示
删除训练任务会永久移除所有指标、日志和检查点。此操作无法撤销。

​
model

管理模型 — 列出、删除，以及即将推出的部署/导出/构建操作。

​
model list

列出活跃工作空间中的模型。 
osmosis model list [--limit N] [--all]
选项类型默认值说明
--limitint50显示的最大模型数量
--allflag—显示所有模型

​
model delete

从活跃工作空间删除模型。 
osmosis model delete <name> [--yes]
参数 / 选项类型说明
namestr（必填）模型路径（例如 google/gemma-2-9b-it）
-y, --yesflag跳过确认提示
您不能删除有活跃训练任务依赖的模型。请先删除相关的训练任务。

​
model deploy / model export / model build

osmosis model deploy
osmosis model export
osmosis model build
这些命令即将推出，目前尚不可用。它们在 CLI 中注册为占位符。

​
rollout

列出从工作区同步到 Osmosis 平台的 rollout。

​
rollout list

列出活跃工作空间中的 rollout。 
osmosis rollout list [--limit N] [--all]
选项类型默认值说明
--limitint50显示的最大 rollout 数量
--allflag—显示所有 rollout

​
eval

评估 agent — 对数据集运行评估、使用 LLM-as-judge 评分标准，以及管理评估缓存。

​
eval run

使用 TOML 配置文件对数据集评估 agent。 
osmosis eval run <config_path> [options]
参数 / 选项类型默认值说明
config_pathstr（必填）—评估 TOML 配置文件的路径
--freshflag—丢弃缓存结果并重新运行所有行
--retry-failedflag—仅重新运行之前失败的行
--limitint所有行评估的最大行数
--offsetint0跳过前 N 行
-q, --quietflag—抑制进度输出
--debugflag—启用调试日志和执行追踪
-o, --output-pathstr—覆盖结构化输出目录
--log-samplesflag—将完整对话日志保存为 JSONL
--batch-sizeint来自配置覆盖并发批量大小
# 运行完整评估
osmosis eval run configs/eval/default.toml

# 仅重新运行失败行并启用调试输出
osmosis eval run configs/eval/default.toml --retry-failed --debug
详情请参阅配置文件和本地评估。

​
eval rubric

运行 LLM-as-judge 评估：使用任何 LiteLLM 兼容模型对对话按评分标准打分。 
osmosis eval rubric [options]
必填选项：
选项类型说明
-d, --datastr包含对话的 JSONL 文件路径
-r, --rubricstr评分标准文本（内联字符串）或 @file.txt 从文件读取
--modelstrLiteLLM 格式的评判模型（例如 openai/gpt-5.2）
可选：
选项类型默认值说明
-n, --numberint1每条记录的评估运行次数
-o, --outputstr—评估结果 JSON 输出路径
--api-keystr—评判模型的 API 密钥
--timeoutfloat—请求超时时间（秒）
--score-minfloat0.0最低分数值
--score-maxfloat1.0最高分数值
# 内联评分标准
osmosis eval rubric \
  -d data/conversations.jsonl \
  -r "Score the response on accuracy and completeness" \
  --model openai/gpt-5.2

# 从文件读取评分标准
osmosis eval rubric \
  -d data/conversations.jsonl \
  -r @rubrics/accuracy.txt \
  --model openai/gpt-5.2 \
  -o results/rubric-scores.json

​
eval cache dir

打印评估缓存根目录路径。 
osmosis eval cache dir

​
eval cache ls

列出缓存的评估，支持可选筛选条件。 
osmosis eval cache ls [--model STR] [--dataset STR] [--status STR]
选项类型说明
--modelstr按模型名称筛选
--datasetstr按数据集路径筛选
--statusstr按状态筛选：in_progress 或 completed

​
eval cache rm

移除缓存的评估。 
osmosis eval cache rm [task_id] [options]
参数 / 选项类型说明
task_idstr（可选）要删除的特定缓存条目的任务 ID
--allflag删除所有缓存的评估
--modelstr按模型名称筛选
--datasetstr按数据集路径筛选
--statusstr按状态筛选：in_progress 或 completed
-y, --yesflag跳过确认提示
# 移除特定的缓存评估
osmosis eval cache rm abc123

# 移除特定模型的所有缓存评估
osmosis eval cache rm --model openai/gpt-5.2 --yes

​
auth

管理身份验证。详情请参阅安装与身份验证。
命令说明
osmosis auth login通过浏览器 OAuth 或令牌进行身份验证
osmosis auth logout撤销会话并清除凭据
osmosis auth whoami显示当前用户和活跃工作空间

​
workspace

管理平台工作空间。详情请参阅安装与身份验证。
命令说明
osmosis workspace交互式 TUI，用于浏览工作空间内容
osmosis workspace list列出可用的工作空间
osmosis workspace create <name>创建新工作空间
osmosis workspace switch <name>切换活跃工作空间
osmosis workspace delete <name>删除工作空间

​
upgrade

将 CLI 自升级到 PyPI 上发布的最新版本。 
osmosis upgrade
自动检测您的安装方式（pip、pipx 或 uv tool）并运行相应的升级命令。升级前会显示当前已安装的版本和最新可用版本。