Skip to content

Command Line Interface (CLI)

The CLI tool allows you to use the UP42 functionality from the command line. It is installed automatically with and based on the Python SDK.

up42

Usage:

up42 [OPTIONS] COMMAND [ARGS]...

Options:

  -pid, --project-id TEXT        Your project ID, get it in the Project
                                 settings in the console.

  -pkey, --project-api-key TEXT  Your project API KEY, get in the Project
                                 settings in the console.

  -cfg, --config-file PATH       File path to the config.json with
                                 {project_id: '...', project_api_key: '...'}

  --env TEXT

auth

Check authentication.

Usage:

up42 auth [OPTIONS]

catalog

UP42 catalog search. You can search for satellite image scenes for different sensors and criteria like cloud cover.

Usage:

up42 catalog [OPTIONS] COMMAND [ARGS]...

construct-parameters

Follows STAC principles and property names to create a filter for catalog search.

Usage:

up42 catalog construct-parameters [OPTIONS] GEOM_FILE

Options:

  --start-date [%Y-%m-%d]         Query period starting day, format
                                  '2020-01-01'.

  --end-date [%Y-%m-%d]           Query period ending day, format
                                  '2020-01-01'.

  --sensors [pleiades|spot|sentinel1|sentinel2|sentinel3|sentinel5p]
                                  Imagery sensors to search for.
  --max-cloud-cover INTEGER RANGE
                                  Maximum cloudcover percentage. 100 will
                                  return all scenes,8.4 will return all scenes
                                  with 8.4 or less cloudcover.

  --limit INTEGER                 The maximum number of search results.

Searches the catalog for the search parameters and returns the metadata of the matching scenes. Generate search parameters with 'up42 catalog construct-parameters'.

Usage:

up42 catalog search [OPTIONS] SEARCH_PARAMETERS_JSON

config

Create a config file.

Usage:

up42 config [OPTIONS]

Options:

  --env TEXT

get-block-details

Get details of block by block name.

Usage:

up42 get-block-details [OPTIONS]

Options:

  -n, --block-name TEXT  Block name to get details.  [required]

get-blocks

Get public blocks information.

Usage:

up42 get-blocks [OPTIONS]

Options:

  -t, --block-type [data|processing]
                                  Filter by block type.
  --basic / --full                Show basic or full block information.

job

Get job status, results and more.

Usage:

up42 job [OPTIONS] COMMAND [ARGS]...

Options:

  -jid, --job-id TEXT  Your job ID, get it by creating a job or running 'up42
                       project workflow get-jobs'  [required]

cancel-job

Cancel a job that is running.

Usage:

up42 job cancel-job [OPTIONS]

download-quicklooks

Download a job's quicklooks.

Usage:

up42 job download-quicklooks [OPTIONS] OUTPUT_DIRECTORY

download-results

Download and unpack the job results.

Usage:

up42 job download-results [OPTIONS] OUTPUT_DIRECTORY

get-jobtasks

Get the individual items of the job.

Usage:

up42 job get-jobtasks [OPTIONS]

get-jobtasks-results-json

Convenience function to get the resulting data.json of all job tasks.

Usage:

up42 job get-jobtasks-results-json [OPTIONS]

get-logs

Convenience function to print or return the logs of all job tasks.

Usage:

up42 job get-logs [OPTIONS]

get-results-json

Get the job results data.json.

Usage:

up42 job get-results-json [OPTIONS]

get-status

Get the job status.

Usage:

up42 job get-status [OPTIONS]

info

Get information about the job.

Usage:

up42 job info [OPTIONS]

track-status

Track the job status with regular time intervals.

Usage:

up42 job track-status [OPTIONS]

Options:

  -i, --interval INTEGER RANGE  Interval between getting job status in
                                seconds.

project

Create and get workflows, manage project settings and more.

Usage:

up42 project [OPTIONS] COMMAND [ARGS]...

create-workflow

Create a workflow.

Usage:

up42 project create-workflow [OPTIONS] NAME

get-project-settings

Get the project settings.

Usage:

up42 project get-project-settings [OPTIONS]

get-workflows

Get the project workflows.

Usage:

up42 project get-workflows [OPTIONS]

update-project-settings

Update project settings.

Usage:

up42 project update-project-settings [OPTIONS]

Options:

  --max-aoi-size INTEGER RANGE    The maximum area of interest geometry size,
                                  from 1-1000 sqkm, default 10 sqkm.

  --max-concurrent-jobs INTEGER RANGE
                                  The maximum number of concurrent jobs, from
                                  1-10, default 1.

  --number-of-images INTEGER RANGE
                                  The maximum number of images returned with
                                  each job, from 1-20, default 10.

workflow-from-name

Use a workflow from name.

Usage:

up42 project workflow-from-name [OPTIONS]

Options:

  -n, --workflow-name TEXT  Workflow name to use.  [required]

validate-manifest

Validate a block manifest.

Usage:

up42 validate-manifest [OPTIONS] MANIFEST_JSON

workflow

Add workflow tasks, run a job and more.

Usage:

up42 workflow [OPTIONS] COMMAND [ARGS]...

Options:

  -wid, --workflow-id TEXT  Your workflow ID, get it by creating a workflow or
                            running 'up42 project get-workflows'  [required]

add-workflow-tasks

Adds or overwrites workflow tasks. - Name is arbitrary but best use the block name. Always use :1 to be able to identify the order when two times the same workflow task is used. - API by itself validates if the underlying block for the selected block-id is available.

Usage:

up42 workflow add-workflow-tasks [OPTIONS] INPUT_TASKS_JSON

delete

Delete the workflow.

Usage:

up42 workflow delete [OPTIONS]

get-compatible-blocks

Get all compatible blocks for the current workflow.

Usage:

up42 workflow get-compatible-blocks [OPTIONS]

get-jobs

Get the jobs ran with this workflow.

Usage:

up42 workflow get-jobs [OPTIONS]

get-parameters-info

Get info about the parameters of each task in the workflow to make it easy to construct the desired parameters.

Usage:

up42 workflow get-parameters-info [OPTIONS]

get-workflow-tasks

Get the workflow tasks list (DAG).

Usage:

up42 workflow get-workflow-tasks [OPTIONS]

Options:

  --basic / --full  Show basic or full task information.

info

Get information about the workflow.

Usage:

up42 workflow info [OPTIONS]

run-job

Creates and runs a new job.

Usage:

up42 workflow run-job [OPTIONS] INPUT_PARAMETERS_JSON

Options:

  --track  Track status of job in shell.

test-job

Create a run a new test job (Test Query). With this test query you will not be charged with any data or processing credits, but have a preview of the job result.

Usage:

up42 workflow test-job [OPTIONS] INPUT_PARAMETERS_JSON

Options:

  --track  Track status of job in shell.

update-name

Update the workflow name.

Usage:

up42 workflow update-name [OPTIONS]

Options:

  -n, --workflow-name TEXT  New name for the workflow.  [required]
  --description TEXT        An optional description for the workflow.