Cloudsmith Documentation Hub

Welcome to the Cloudsmith Documentation Hub. You'll find comprehensive guides and documentation to help you start working with Cloudsmith as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Create a Repository

You can create a new repository in three ways:

  • Via the Cloudsmith CLI
  • Via the Website UI
  • Via the Cloudsmith API

Via the Cloudsmith CLI

In the following examples:

Identifier

Description

OWNER

A Cloudsmith username or organisation account name (namespace)

REPO-NAME

A name for your repository.

REPO-DESC

Description for your Repository

REPO-TYPE

The type of repository - "Public" or "Private"

REPO-IDENTIFIER

A unique identifier for the repository, also referred to as a 'slug'. It can only contain lowercase alphanumeric characters, hyphens, and underscores. (optional, one will be generated if not specified)

Create a REPO-CONFIG.json file with the following:

{
    "name": "REPO-NAME",
    "description": "REPO-DESC",
    "repository_type_str": "REPO-TYPE",
    "slug": "REPO-IDENTIFIER"
}

You can create then a repository via the Cloudsmith CLI using the following command:

cloudsmith repos create OWNER REPO-CONFIG.json

Example

example-repo-config.json file:

{
    "name": "Example Repository",
    "description": "Example packages repository",
    "repository_type_str": "Private",
    "slug": "example-repo1"
}

Create repository command:

cloudsmith repos create demo example-repo-config.json
cloudsmith repos create commandcloudsmith repos create command

cloudsmith repos create command


Via the Website UI

You can create a repository by clicking on the + dropdown on the top menu bar and selecting "New Repository".

New Repository ButtonNew Repository Button

New Repository Button

That will take you to the "Create Package Repository" form:

Create Package Repository FormCreate Package Repository Form

Create Package Repository Form

Here you can create a new repo by selecting a Repository Owner (the namespace you want the repo to live under) and a name. You can also specify an optional 'slug' (identifier) for the repository, this is what will appear in the URL for the repository. The identifier can only contain lowercase alphanumeric characters, hyphens, and underscores. If you don't specify an identifier, one will be automatically generated from the repository name for you.

The Storage Region allows you to choose a geographic region for the repository (see Custom Storage Regions for further details).
Then you need to select the type; Public, Private or Open-Source.

πŸ“˜

Multi-Tenant Repositories

All Cloudsmith repositories are multi-tenant. This means you can store artifacts of different formats in the same logical grouping. A Maven package can sit beside a Debian package, a Ruby Gem or a Python package!

Public Repositories

All accounts (including free accounts) come with unlimited Public repositories.

If you select Public then all files in the repository are available to anyone. Public repositories may be listed on your Cloudsmith public profile and may be searchable on the Public Package Dashboard (not implemented).

Private Repositories

All paid accounts come with unlimited Private repositories.

Private repositories are private. If required, external access to any files in a private repository is controlled by our Entitlement system. See "How To: Sharing a Private Package" for more details.

Open Source Repositories

All accounts provide Open-Source repositories for all your cool OS projects. We offer this to give back to the OS community which we lovingly support and contribute to.

We ask for some additional information and confirmations to keep you and ourselves right. If you would like to discuss this or potential cross-promotion contact us :)

Back to creating a repository:

Once you've filled in the fields just hit the green "Create" button.

Create Package Repository FormCreate Package Repository Form

Create Package Repository Form

And that's it...

Repository PageRepository Page

Repository Page

The repository is created. You will be able to manage your Repository; upload Packages, manage your Entitlement Tokens, GPG & RSA Keys, access Logs and Statistics, and change the Repository settings.

πŸ“˜

Changing Repository Settings

The good thing about Cloudsmith is that you can change everything later. The name, slug, description, repository type can all be changed if necessary. Although once shared, if you change the settings or naming you may need to communicate this to all interested parties.


Via the Cloudsmith API

For details on how to create a repository via the Cloudsmith API, please see the "Create a Repository" section of the API Reference, including an interactive sandbox where you can test your API Calls.

Updated about a year ago


Create a Repository


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.


Cloudsmith is the new standard in Package Management and Software Distribution

With support for all major package formats, you can trust us to manage your software supply chain.


Start My Free Trial Now