Quickstart for npm

This quick start shows you how to set up a Artifact Registry npm repository and upload a package to it.

Package management is only available to alpha users. To apply for the alpha, complete the sign up form.

Before you begin

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. In the Cloud Console, on the project selector page, select or create a Cloud project.

    Go to the project selector page

  3. Make sure that billing is enabled for your Google Cloud project. Learn how to confirm billing is enabled for your project.

  4. Enable the Artifact Registry API.

    Enable the API

  5. Install and initialize the Cloud SDK.
  6. Install PowerShell, if you want to connect to an npm repository from Windows.

Create an npm repository

To add a repository:

Console

  1. Open the Repositories page in the Cloud Console.

    Open the Repositories page

  2. Click Create Repository.

  3. Specify quickstart-npm-repo as the repository name.

  4. Choose npm as the format.

  5. Under Location Type, select Region and then choose the location us-central1.

  6. Click Create.

The repository is added to the repository list

gcloud

  1. Run the following command to create a new npm repository named quickstart-npm-repo in the location us-central1 with the description "npm repository".

    gcloud beta artifacts repositories create quickstart-npm-repo --repository-format=npm \
    --location=us-central1 [--description="npm repository"]
    
  2. Run the following command to verify that your repository was created.

    gcloud beta artifacts repositories list
    

For more information about Artifact Registry commands, run the command gcloud beta artifacts.

Configure npm

  1. Create an npm package to upload. If you don't have a package available to use with this quickstart, run the following command to create a plain package.json file:

    npm init -y
    
  2. To simplify gcloud commands, set the default repository to quickstart-npm-repo and the default location to us-central1. After the values are set, you do not need to specify them in gcloud commands that require a repository or a location.

    To set the repository, run the command:

    gcloud config set artifacts/repository quickstart-npm-repo
    

    To set the location, run the command:

    gcloud config set artifacts/location us-central1
    

    For more information about these commands, see the gcloud config set documentation.

  3. Configure your npm project to deploy to the Artifact Registry repository that you created.

    1. Run the following command. The command returns configuration settings to add to your npm configuration file.

      gcloud beta artifacts print-settings npm
      

      When an npm scope is not specified, the Artifact Registry repository is configured as the default repository. For information about including the scope, or associating a scope later with a repository, see the authentication documentation.

      The output of the gcloud command looks like this:

      Please insert following snippet into your .npmrc
      
      ======================================================
      registry=https://us-central1-npm.pkg.dev/PROJECT/quickstart-npm-repo/
      //us-central1-npm.pkg.dev/PROJECT/quickstart-npm-repo/:_password=""
      //us-central1-npm.pkg.dev/PROJECT/quickstart-npm-repo/:username=oauth2accesstoken
      //us-central1-npm.pkg.dev/PROJECT/quickstart-npm-repo/:email=not.valid@email.com
      //us-central1-npm.pkg.dev/PROJECT/quickstart-npm-repo/:always-auth=true
      ======================================================
      
    2. For this quickstart, add the configuration settings from the previous step to your project .npmrc file. The file is usually in the same directory as the package.json file.

      Replace PROJECT with your project ID.

      To learn about storing the settings in the npm global config file, see Setting up authentication for npm.

Upload a package to the repository

  1. Refresh the access token for connecting to the repository. google-artifactregistry-auth is a client library that updates credentials for Artifact Registry repositories. To refresh credentials, use one of these options:

    • Add a script to the package.json file in your project.

      "scripts": {
        "artifactregistry-login": "npx google-artifactregistry-auth"
      }
      
      npm run artifactregistry-login PROJECT-NPMRC --registry https://registry.npmjs.org/
      

      Where PROJECT-NPMRC is the path to the .npmrc file in your project directory.

    • For versions of npm older than 5.2.0, perform the following steps:

      1. Run the command:
      npm install google-artifactregistry-auth --save-dev --registry https://registry.npmjs.org/
      
      1. Add it to an authentication script:
      "scripts": {
          "artifactregistry-login": "./node_modules/.bin/artifactregistry-auth",
      }
      

      Run the script

      npm run artifactregistry-login PROJECT-NPMRC
      

      Where PROJECT-NPMRC is the path to the .npmrc file in your project directory.

  2. Add your package to the repository. You can use npm commands and yarn commands to add packages or to get package information.

    Use the appropriate command:

    • npm - npm publish, npm install, and npm view
    • yarn - yarn publish, yarn add, and yarn info

View the package in the repository

To verify that your image was added to the repository:

Console

  1. Open the Repositories page in the Cloud Console.

    Open the Repositories page

  2. In the repository list, click the quickstart-npm-repo repository.

    The Packages page lists the packages in the repository.

  3. Click on a package to view package versions.

gcloud

To list the images in the default quickstart-npm-repo repository, run the following command:

 gcloud beta artifacts packages list

To view versions for a package, run the following command:

gcloud beta artifacts versions list --package=PACKAGE

Where PACKAGE is the package ID.

Clean up

To avoid incurring charges to your Google Cloud account for the resources used in this quickstart, follow these steps.

Before you remove a repository, ensure that any packages that you want to keep are available in another location.

To delete the repository:

Console

  1. Open the Repositories page in the Cloud Console.

    Open the Repositories page

  2. In the repository list, select the quickstart-npm-repo repository.

  3. Click Delete.

gcloud

  1. To delete the quickstart-npm-repo repository, run the following command:

    gcloud beta artifacts repositories delete quickstart-npm-repo
    
  2. If you want to remove the default repository and location settings that you configured for the active gcloud configuration, run the following commands:

    gcloud config unset artifacts/repository
    gcloud config unset artifacts/location
    

What's next