Version: 2021.2
Cloud Content Delivery interfaces
Unity CCD Develop Dashboard

Unity CCD Command-line interface (CLI)

Important: The Unity Cloud Content Delivery documentation has moved to docs.unity.com. Please visit the new site for the most up to date information about Unity CCD.

The command-line interface (CLI) is the recommended method of interacting with Cloud Content Delivery (CCD). With this tool, you can use the command line to control every aspect of your project, from file management to organizing your release pipeline.

You can perform many similar functions in the Develop Dashboard, but you need to use the CLI to copy files to your bucket, or synchronize entire folders.

Getting started

To set up CCD for CLI:

  1. If you are using Unity services for the first time:
    1. Create a Unity ID account (if you don’t already have one).
    2. Log into the Develop Dashboard from the Develop tab.
    3. Click Create New Project, and enter the details in the Create New Project window.
  2. In the Develop Dashboard, select your project.
  3. Select the project name, or click View.
  4. In the Develop Dashboard’s Overview page, in the left-side navigation bar, select Content Delivery.
  5. In the left-side navigation bar, select Download CLI.
  6. To download the CLI, locate the version of your operating system, then select the download icon.
  7. In the left-side navigation bar, go to the API Key section.
  8. Copy your API key.
  9. Run the CLI on the machine from which you are uploading content.
  10. Log into the CLI using your API key via the auth command.

CCD is now ready for you to use.

CLI usage

The basic form of a CCD command in the CLI is as follows:

$ ucd [command]

The available commands are:

  • auth: Authenticates with Content Delivery.
  • badges: Manages badges for a release.
  • buckets: Manages buckets for a project.
  • config: Manages options for setting and identifying the current bucket.
  • entries: Manages entries for the current bucket.
  • releases: Manages the releases for the current bucket.

To see the version of the CLI you are currently using, add the --version flag:

$ ucd --version

You can add the following global flags after any command:

  • --apikey string: User-specified API key for accessing Content Delivery.
  • -h, --help: Displays any further parameters and flags for a given command.
  • -q, --quiet: Disables the display of operations performed by the specified command.
  • -v, --verbose: Displays error information.

例:

  • To create a bucket:
    $ ucd buckets create [project_id] [bucket_name]
  • To list all buckets for a project:
    $ ucd buckets list [project_id]
  • To set the current bucket as the active bucket:
    $ ucd config set bucket [bucket_id]
  • To synchronize a local folder with the current bucket:
    $ ucd entries sync [local_dir_path]
  • To view a list of all entries in the current bucket:
    $ ucd entries list

Bucket and entry names are case sensitive.

For a full example of how to use the CLI, see Using CCD via the command line interface.

Cloud Content Delivery interfaces
Unity CCD Develop Dashboard