Dart is a client-optimized programming language developed by Google.

For more information on Dart, please see:

• Dart.dev: The official website for Dart
• Pub.dev: The official public repository for Dart packages

Contextual Documentation

The examples in this document are generic. Cloudsmith provides contextual setup instructions within each repository, complete with copy n' paste snippets (with your namespace/repo pre-configured).

In the following examples:

Upload a Package

Upload via the Cloudsmith CLI

For full details of how to install and setup the Cloudsmith CLI, see Command Line Interface.

The command to upload a Dart package via the Cloudsmith CLI is:

cloudsmith push dart OWNER/REPOSITORY PACKAGE_NAME-PACKAGE_VERSION.tgz

Example:

cloudsmith push dart org/repo your-package-1.0.0.tgz

Upload via Cloudsmith Website

Please see Upload a Package for details of how to upload via the Website UI.

Download / Install a Package

🚧

When using PUB_HOSTED_URL, all dependencies must be present in the specified Cloudsmith repository. Dart repositories don't (currently) proxy upstream sources and can only serve packages explicitly uploaded to Cloudsmith. So if set, you cannot resolve any dependencies from pub.dev.

If PUB_HOSTED_URL is unset, any packages not uploaded to Cloudsmith (and with a specific Cloudsmith URL set in the pubspec.yaml file) will be fetched from pub.dev

Setup

Before you can install packages from your Cloudsmith repository you'll need to configure your environment for access. The configuration is defined using the PUB_HOSTED_URL environment variable.

Public Repositories

Linux / Mac

export PUB_HOSTED_URL=https://dl.cloudsmith.io/public/OWNER/REPOSITORY/dart/

Windows (cmd)

set PUB_HOSTED_URL=https://dl.cloudsmith.io/public/OWNER/REPOSITORY/dart/

Windows (Powershell)

$env:PUB_HOSTED_URL=https://dl.cloudsmith.io/public/OWNER/REPOSITORY/dart/

Private Repositories

📘

Private Cloudsmith repositories require authentication. You can choose between two types of authentication, Entitlement Token Authentication or HTTP Basic Authentication.

The setup method will differ depending on what authentication type you choose to use.

🚧

Entitlement Tokens, User Credentials and API-Keys should be treated as secrets, and you should ensure that you do not commit them in configurations files along with source code or expose them in any logs

Linux / Mac

export PUB_HOSTED_URL=https://dl.cloudsmith.io/TOKEN/OWNER/REPOSITORY/dart/

export PUB_HOSTED_URL=https://USERNAME:[email protected]/basic/OWNER/REPOSITORY/dart/

export PUB_HOSTED_URL=https://USERNAME:[email protected]/basic/OWNER/REPOSITORY/dart/

export PUB_HOSTED_URL=https://token:[email protected]/basic/OWNER/REPOSITORY/dart/

Windows (cmd)

set PUB_HOSTED_URL=https://dl.cloudsmith.io/TOKEN/OWNER/REPOSITORY/dart/

set PUB_HOSTED_URL=https://USERNAME:[email protected]/basic/OWNER/REPOSITORY/dart/

set PUB_HOSTED_URL=https://USERNAME:[email protected]/basic/OWNER/REPOSITORY/dart/

set PUB_HOSTED_URL=https://token:[email protected]/basic/OWNER/REPOSITORY/dart/

Windows (Powershell)

$env:PUB_HOSTED_URL=https://dl.cloudsmith.io/TOKEN/OWNER/REPOSITORY/dart/

$env:PUB_HOSTED_URL=https://USERNAME:[email protected]/basic/OWNER/REPOSITORY/dart/

$env:PUB_HOSTED_URL=https://USERNAME:[email protected]/basic/OWNER/REPOSITORY/dart/

$env:PUB_HOSTED_URL=https://token:[email protected]/basic/OWNER/REPOSITORY/dart/

Specifying Dependencies

Add the following to the dependencies section of your pubspec.yaml file:

Public Repositories

dependencies:
 DEPENDENCY_NAME:
    hosted:
      name: PACKAGE_NAME
      url: https://dl.cloudsmith.io/public/OWNER/REPOSITORY/dart/
      version: PACKAGE_VERSION

Private Repositories

dependencies:
  DEPENDENCY_NAME:
    hosted:
      name: PACKAGE_NAME
      url: https://dl.cloudsmith.io/TOKEN/OWNER/REPOSITORY/dart/
      version: PACKAGE_VERSION

dependencies:
  DEPENDENCY_NAME:
    hosted:
      name: PACKAGE_NAME
      url: https://USERNAME:[email protected]/basic/OWNER/REPOSITORY/dart/
      version: PACKAGE_VERSION

dependencies:
  DEPENDENCY_NAME:
    hosted:
      name: PACKAGE_NAME
      url: https://USERNAME:[email protected]/basic/OWNER/REPOSITORY/dart/
      version: PACKAGE_VERSION

dependencies:
  DEPENDENCY_NAME:
    hosted:
      name: PACKAGE_NAME
      url: https://token:[email protected]/basic/OWNER/REPOSITORY/dart/
      version: PACKAGE_VERSION

Installing a Package

Once set up, pub will download the dependency to .pub_cache and update the pubspec.lock and .packages after running following command:

pub get

Configuration Example

A complete (but minimal) example of a pubspec.yaml file specifying a dependency that is hosted in a public Cloudsmith repository would look like:

name: dart_demo_project
dependencies:
  cloudsmith_dart_example:
    hosted:
      name: cloudsmith_dart_example
      url: https://dl.cloudsmith.io/public/cloudsmith/examples/dart/
      version: 1.0.15779875111116

Please also see the pubspec docs for further examples of pubspec files.

Upstream Proxying / Caching

Not Supported

Key Signing Support

Not Supported by Format

Troubleshooting

Please see the Troubleshooting page for further help and information.