earthengine tool is a utility program that allows you to manage Earth Engine
assets and tasks from the command line. It is installed automatically when
you install the Python API. To check whether the tool is
installed and functioning correctly, type the following on a command line:
If the tool is properly installed then it will print out a short summary of available commands. To get help on a specific command, use:
earthengine command -h
When you first install the Python API you will need to log in using the
authenticate command described below. The following sections describe the
available commands in more detail.
Authenticates the command line tool and Python client library to Earth Engine. Example:
Earth Engine uses the OAuth 2.0 protocol for authenticating clients. Running this command will prompt you through the authentication process using your web browser. See Setting Up Authentication Credentials in the Python API documentation for additional details.
Prints or updates the access control list (ACL) of an Earth Engine asset. The ACL controls who can read or write to an asset. Examples:
earthengine acl get users/username/asset_id earthengine acl set public users/username/asset_id earthengine acl ch -u email@example.com:R users/username/asset_id
get subcommand prints a JSON description of the ACL. The
subcommand sets an ACL provided in a file with the same JSON format. You can easily copy an
ACL from one asset to others by saving the output from
get and providing it
The set subcommand also accepts two special ACL names:
private: Removes permissions from everyone except the owner.
public: Grants read permission to all users.
ch subcommand allows you to make individual changes to an ACL. To grant
read permission specify
AllUsers may be used to grant or revoke read permission to or from all
users. (Note that revoking
AllUsers permissions does not revoke any
additional permissions you may have also granted to individual users.)
Prints or updates metadata associated with the an Earth Engine asset. Examples:
earthengine asset info users/username/asset_id earthengine asset set -p name=value users/username/asset_id
info subcommand prints detailed information about the asset, including
its metadata, in JSON form. The
set subcommand sets individual metadata
properties on an asset.
The values of metadata properties that you set may be either numbers or strings. When
setting property names using the
(date). For example, this will set a string-valued
property with the value
earthengine asset set -p '(string)name=42' users/username/asset_id
(The quotes in this example prevent the shell from interpreting the parentheses. They may or may not be necessary, depending on your shell and platform.)
Date properties are just numbers that represent a number of milliseconds since the Unix epoch (i.e. midnight on January 1st, 1970) and may be specified directly as a number or in one of the following formats:
YYYY-MM-DD YYYY-MM-DDThh:mm:ss YYYY-MM-DDThh:mm:ss.f
The time zone is assumed to be UTC. You may set the special start and end time properties
earthengine asset set --time_start 1978-10-15T12:34:56 users/username/asset_id
Copies an asset. Example:
earthengine cp users/username/asset_id users/username/new_asset_id
Creates new folders and image collections. Example:
earthengine create folder users/username/folder_id earthengine create collection users/username/collection_id
folder subcommand to create folders and the
create image collections. You can specify the
Lists the contents of one or more folders or collections. Example:
earthengine ls users/username
earthengine ls -m 10 users/username/my_large_collection
ls command with no arguments will list the top-level folders
that you own.
Moves or renames an asset. Example:
earthengine mv users/username/asset_id users/username/new_asset_id
Deletes one or more assets. Example:
earthengine rm users/username/asset_id earthengine rm -r users/username/folder_id
You can use the
Prints or information about or manages long-running tasks. Examples:
earthengine task list earthengine task info TASK_ID earthengine task cancel TASK_ID
list subcommand lists basic information about the tasks that you submitted
info subcommand prints detailed information about individual tasks.
cancel subcommand cancels one or more running tasks.
Uploads files from Google Cloud Storage to Earth Engine. For example, to upload an asset using default settings:
earthengine upload image --asset_id=users/username/asset_id gs://bucket/image.tif
If you specify multiple input files they will be interpreted as tiles of a single image asset. You can learn more about the options for uploading images to Earth Engine in Uploading image assets: Advanced options.
You can specify the pyramid reduction policy using the
mean (the default),
max. This will control how Earth Engine generates the pyramid of
lower-resolution versions of your image:
earthengine upload image --asset_id=users/username/asset_id --pyramiding_policy=sample gs://bucket/image.tif
You can use the
earthengine upload image --asset_id=users/username/asset_id --last_band_alpha gs://bucket/image.tif
You can specify a no-data value using the
earthengine upload image --asset_id=users/myuser/asset --nodata_value=255 gs://bucket/image.tif
You may also specify metadata properties to set on the asset using the same flags that are
accepted by the
asset set command described above.