Skip to main content

CLI Reference

Complete command reference for the vfrog CLI. For installation and setup, see the CLI Overview. For end-to-end examples, see CLI Workflows.

Authentication​

vfrog login​

Authenticate with the vfrog platform.

vfrog login [flags]
FlagTypeDescription
--emailstringAccount email (skips interactive prompt)
--passwordstringAccount password (skips interactive prompt)

Tokens are stored in ~/.vfrog/config-<environment>.json and refresh automatically.

Configuration​

vfrog config show​

Display the current configuration context.

vfrog config show

vfrog config set organisation​

Set the active organisation.

vfrog config set organisation --organisation_id <id>
FlagTypeDescription
--organisation_idstringOrganisation ID (required)
warning

Changing the organisation clears the active project and object.

vfrog config set project​

Set the active project.

vfrog config set project --project_id <id>
FlagTypeDescription
--project_idstringProject ID (required)
warning

Changing the project clears the active object.

vfrog config set object​

Set the active object.

vfrog config set object --object_id <id>
FlagTypeDescription
--object_idstringObject ID (required)

Organisations​

vfrog organisations list​

List organisations you belong to.

vfrog organisations list

Alias: vfrog orgs list

Projects​

vfrog projects list​

List projects in the active organisation.

vfrog projects list

Requires: organisation_id

vfrog projects create​

Create a new project.

vfrog projects create <name>
ArgumentTypeDescription
namestringProject name (required)

Requires: organisation_id

vfrog projects delete​

Delete a project.

vfrog projects delete --project_id <id> [flags]
FlagTypeDescription
--project_idstringProject ID (required)
--forcebooleanSkip confirmation prompt

Requires: organisation_id

Dataset Images​

vfrog dataset_images upload​

Upload dataset images from URLs, a local file, or a local directory.

vfrog dataset_images upload [urls...] [flags]
FlagTypeDescription
--filestringPath to a local image file
--dirstringPath to a directory of images

You can pass one or more URLs as positional arguments, or use --file/--dir for local files. Images are uploaded to vfrog's CDN.

Requires: organisation_id + project_id

vfrog dataset_images import​

Import dataset images from a CSV file.

vfrog dataset_images import --csv <path>
FlagTypeDescription
--csvstringPath to CSV file (required)

CSV format (header row required, only image_url is mandatory):

image_url,external_id,label
https://example.com/img1.jpg,EXT001,scene_1

Requires: organisation_id + project_id

vfrog dataset_images list​

List all dataset images in the active project.

vfrog dataset_images list

Requires: organisation_id + project_id

vfrog dataset_images delete​

Delete a dataset image.

vfrog dataset_images delete --dataset_image_id <id>
FlagTypeDescription
--dataset_image_idstringDataset image ID (required)

Requires: organisation_id + project_id

Objects​

vfrog objects create​

Create an object (product/reference image).

vfrog objects create [url] [flags]
FlagTypeDescription
--filestringPath to a local image file
--labelstringObject label
--external_idstringExternal identifier

Pass a URL as a positional argument, or use --file for a local image.

Requires: organisation_id + project_id

vfrog objects list​

List objects in the active project.

vfrog objects list

Requires: organisation_id + project_id

vfrog objects delete​

Delete an object.

vfrog objects delete --object_id <id>
FlagTypeDescription
--object_idstringObject ID (required)

Requires: organisation_id + project_id

Iterations​

All iteration commands accept either --iteration_id or --iteration_number (with --object_id or the active object). Using --iteration_number is a shorthand that looks up the iteration ID automatically.

vfrog iterations list​

List iterations for an object.

vfrog iterations list [flags]
FlagTypeDescription
--object_idstringObject ID (defaults to active object)

Requires: organisation_id + project_id + object_id

vfrog iterations create​

Create a new iteration.

vfrog iterations create <object_id> [flags]
ArgumentTypeDescription
object_idstringObject ID (required)
FlagTypeDescription
--randomintNumber of random dataset images to link (default: 20)

Requires: organisation_id + project_id

vfrog iterations ssat​

Start SSAT (Semi-Supervised Active Training) annotation on an iteration.

vfrog iterations ssat [flags]
FlagTypeDescription
--iteration_idstringIteration ID
--iteration_numberintIteration number (uses active object)
--randomintOverride linked images with N random images from the project
--restartbooleanRestart the iteration before running SSAT
--industrystringIndustry hint (skips automatic control check)

Iteration 1 runs a control check to detect the project's industry via LLM, then uses the annotator pipeline. Iteration 2+ uses inference with the trained model from the previous iteration.

Supported industries: Retail, Agriculture, Aquaculture, Fisheries, Manufacturing, Mechanical Engineering, PPE

vfrog iterations status​

Check the status of an iteration.

vfrog iterations status [flags]
FlagTypeDescription
--iteration_idstringIteration ID
--iteration_numberintIteration number (uses active object)
--watchbooleanPoll until completion (every 5 seconds)
--intervalintCustom polling interval in seconds (with --watch)

vfrog iterations annotations​

View annotations produced by SSAT.

vfrog iterations annotations [flags]
FlagTypeDescription
--iteration_idstringIteration ID
--iteration_numberintIteration number (uses active object)

Table output shows dataset image ID, annotation count, and creation time. Use --json for full annotation data including bounding box coordinates.

vfrog iterations control​

Submit SSAT control feedback for quality assessment.

vfrog iterations control --iteration_id <id>
FlagTypeDescription
--iteration_idstringIteration ID (required)

vfrog iterations halo​

Get the HALO (Human Assisted Labelling of Objects) web UI URL for reviewing annotations.

vfrog iterations halo [flags]
FlagTypeDescription
--iteration_idstringIteration ID
--iteration_numberintIteration number (uses active object)

vfrog iterations train​

Train a YOLO model on the iteration's annotations.

vfrog iterations train [flags]
FlagTypeDescription
--iteration_idstringIteration ID
--iteration_numberintIteration number (uses active object)

vfrog iterations deploy​

Deploy a trained model to production.

vfrog iterations deploy [flags]
FlagTypeDescription
--iteration_idstringIteration ID
--iteration_numberintIteration number (uses active object)

Deployment creates a class record and model-class mapping for API routing. The iteration must have trained_status: completed and a valid model.

vfrog iterations next​

Create the next iteration from the current one.

vfrog iterations next [flags]
FlagTypeDescription
--iteration_idstringIteration ID
--iteration_numberintIteration number (uses active object)

vfrog iterations restart​

Restart an iteration (delete and recreate).

vfrog iterations restart --iteration_id <id>
FlagTypeDescription
--iteration_idstringIteration ID (required)

vfrog iterations delete​

Delete an iteration.

vfrog iterations delete --iteration_id <id>
FlagTypeDescription
--iteration_idstringIteration ID (required)

Inference​

vfrog inference​

Run single image inference.

vfrog inference [flags]
FlagTypeDescription
--api-keystringAPI key (or set VFROG_API_KEY env var)
--image_urlstringURL of the image to process
--imagestringPath to a local image file

vfrog inference batch​

Run batch inference on up to 10 images.

vfrog inference batch [flags]
FlagTypeDescription
--api-keystringAPI key (or set VFROG_API_KEY env var)
--image_urlstringComma-separated image URLs
--external_idstringExternal identifier for tracking

vfrog inference status​

Check the status of an inference request.

vfrog inference status <request_id> [flags]
ArgumentTypeDescription
request_idstringInference request ID (required)
FlagTypeDescription
--api-keystringAPI key (or set VFROG_API_KEY env var)

vfrog inference feedback​

Submit feedback on an inference result.

vfrog inference feedback [flags]
FlagTypeDescription
--api-keystringAPI key (or set VFROG_API_KEY env var)
--request_idstringInference request ID (required)
--ratingintFeedback rating: 1 (positive), 0 (neutral), -1 (negative)

Export​

vfrog export yolo​

Export an iteration's annotations in YOLO format.

vfrog export yolo --iteration_id <id> --output <path> [flags]
FlagTypeDescription
--iteration_idstringIteration ID (required)
--outputstringOutput directory path (required)
--zipbooleanCreate a ZIP archive of the output

Output structure:

output/
  images/        # Downloaded dataset images
  labels/        # YOLO format annotations (class_id center_x center_y width height)
  data.yaml      # Class names, train/val split (90/10)

vfrog export json​

Export an iteration's annotations as JSON.

vfrog export json --iteration_id <id> --output <path>
FlagTypeDescription
--iteration_idstringIteration ID (required)
--outputstringOutput file path (required)

Utility​

vfrog version​

Print CLI version and environment information.

vfrog version

Global Flags​

These flags are available on all commands:

FlagTypeDescription
--jsonbooleanOutput in JSON format
--configstringCustom config file path
-h, --helpbooleanHelp for any command

Use vfrog <command> --help for detailed flag information on any command.

Next Steps​