platform-cli
Use when operating Ultralytics Platform from a terminal or script with the ul cloud CLI (ul cloud RESOURCE OPERATION key=value, PyPI package ultralytics-platform) — listing, creating, updating, cloning, or moving projects, datasets, and models; inspecting dataset images, statistics, metadata, duplicates, and similar images; starting and monitoring cloud training runs; per-image model validation analysis; downloading weights; exports, deployments, uploads, trash and restore, storage integrations, and account usage, storage, and billing; and building Agents (YOLO, LLM, gate, and alert workflows). For the Platform web UI or local yolo commands, see yolo; for choosing what to train and how to improve it, see yolo-training and yolo-tuning.
ultralytics · Static checks on file
Installation
Read the source and dependencies before running a command. Copying does not install or execute anything.
npx skills add ultralytics/skills --skill platform-cliAbout this skill
name: platform-cli description: > Use when operating Ultralytics Platform from a terminal or script with the ul cloud CLI (ul cloud RESOURCE OPERATION key=value, PyPI package ultralytics-platform) — listing, creating, updating, cloning, or moving projects, datasets, and models; inspecting dataset images, statistics, metadata, duplicates, and similar images; starting and monitoring cloud training runs; per-image model validation analysis; downloading weights; exports, deployments, uploads, trash and restore, storage integrations, and account usage, storage, and billing; and building Agents (YOLO, LLM, gate, and alert workflows). For the Platform web UI or local yolo commands, see yolo; for choosing what to train and how to improve it, see yolo-training and yolo-tuning.
Platform CLI (ul cloud)
ul needs Python 3.11+ and comes with pip install ultralytics or pip install ultralytics-platform. ul cloud <resource> <operation> calls the Platform API through the generated SDK; ul login, ul train, ul predict, the ul cloud train|predict|export|download shortcuts (see yolo), and the other local commands delegate to the ultralytics package. This skill covers Platform operations, not model selection or hyperparameter tuning.
pip install ultralytics # or `pip install ultralytics-platform`
export ULTRALYTICS_API_KEY="YOUR_API_KEY" # or `ul login API_KEY`
ul cloud --help # every resource and operation
ul cloud training start --help # one operation's arguments, types, and choices
Canonical command shapes
ul cloud account summary # plan, credits, counts; `username` is your workspace
ul cloud datasets list # omit owner= for your own workspace; owner=TEAM for a team
ul cloud projects create project=helmets name="Helmet Detection" visibility=private
ul cloud models create body='{"owner":"WS","project":"helmets","model":"exp1","name":"Experiment 1"}'
ul cloud training start model_id=MODEL_ID gpu_type=l4 \
train_args='{"model":"yolo26n.pt","data":"ul://WS/datasets/helmets","epochs":50}'
ul cloud models training project=helmets model=exp1 # live status, epoch progress, metrics
ul cloud models files project=helmets model=exp1 # short-lived weights download URL
Argument rules:
- Use the command shapes shown here without a preliminary
--helpcall. Check operation help when a needed argument is missing or after an argument error. - Arguments are SDK Python names as
key=value(gpu_type,project_id), never--key value. A boolean key given without=valuemeanstrue. Quote JSON for the shell. - An operation takes one
body=JSON object exactly when its help listsbody (dict[str, Any]). These are the operations whose API request is a union of shapes:models create,deployments update,images update,lifecycle delete-trash,datasets ingest,datasets create-batch,upload signed-url,storage-integrations create/discover, andmodels predict/deployments predict. Every other operation takes flat fields; nested objects such astrain_args,metadata, andargsare still JSON values. - Object and array values accept
@file.jsonor@-for stdin. Multipart binaries such as the predictfilefield accept@pathonly. - For body keys and value types, read only the operation's request schema, such as
paths["/api/models"].post.requestBody, from the production contract athttps://platform.ultralytics.com/openapi.json, instead of guessing or loading the whole file.
Behavior rules:
- Output is the complete API response on stdout, printed as JSON, text, or bytes according to its content type. Download operations return expiring signed URLs, not bytes:
datasets export,datasets create-export,models files, and a completedexports retrieve. Preserve them verbatim and fetch them separately. - Failures go to stderr: exit 1 for API/connection errors, 2 for argument/file errors, 130 when interrupted. Interrupting does not cancel a submitted job; use its cancel operation (
models delete-training,exports delete,datasets delete-batch). - There is no
--json,--fields,--dry-run, or automatic pagination.datasets list(limit,include_samples,include_image_urls) andprojects list(limit) take nooffsetorsearch; passinclude_samples=falseto keep dataset listings small.models listrequiresproject=. Operations that page exposepage,offset,cursor, orpage_token. Follow returned continuation fields until exhausted. A limit-only listing may still be incomplete. - An omitted path
ownerdefaults to the logged-in username after one account lookup. Passowner=TEAMfor team workspaces. Account, billing, trash, storage-integration, and Roboflow commands act on the credential's own account, andaccount summarydoes not list teams for API keys. - Display names, URL slugs, database IDs, and URIs are distinct. Training data is
ul://OWNER/datasets/DATASET; starting weights are a checkpoint name orul://OWNER/PROJECT/MODEL. Carry returned IDs and slugs into the next command; retrieve missing identifiers instead of inferring them from names or URLs. Take a named dataset's or project's slug from its listing before retrieving it.
Working method
- Resolve the requested outcome and target. Use exact supplied identifiers; otherwise list and pick one unambiguous match. For several matches, inspect distinguishing metadata and ask when the target or consequence stays ambiguous. When a named resource is not found, say so and offer the closest matches; never substitute another one. A bounded listing does not prove absence; broaden discovery or report what was searched. Look up datasets the user names in their own workspace; find new public datasets with
explore search q=... type=datasets, one short keyword at a time (aerial, thenUAV), narrowed withtask=. Explore dataset search lists token-autocomplete name matches i