Install and configure the New Relic One CLI

Course

This lesson is part of a course that teaches you how to build a New Relic One application from the ground up. If you haven't already, check out the course introduction.

Each lesson in the course builds upon the last, so make sure you've completed the last lesson, Spin up your demo services, before starting this one.

One of the primary elements of the New Relic One SDK is the command line interface (CLI). To create a Nerdpack , you'll need to install the SDK, configure the CLI to work with your New Relic account, and then utilize its create command.

Install and configure the CLI

Step 1 of 3

Select or create a User key.

From the top navigation, go to API keys:

API keys

If you have an existing User key, copy it:

Copy existing key

If not, click Create key:

Create key button

Select User for Key type, optionally add a name and notes, and click Create key:

Create key details

You use this key to associate your New Relic account with the CLI. The CLI then uses the key to manage entities within your account.

Step 2 of 3

Download the SDK's installer for your operating system.

Install the SDK for your operating system:

Once you've installed the SDK, you'll have access to the nr1 CLI. Verify this by checking your SDK version:

bash
$
nr1 --version

Tip

It’s important to distinguish between the newrelic CLI and the nr1 CLI. newrelic is for managing entities in your New Relic account. nr1 is for managing New Relic One applications.

Step 3 of 3

Associate your New Relic account as a CLI profile.

Use nr1 profiles:add to associate the CLI with your New Relic account:

bash
$
nr1 profiles:add --name <profile name> --api-key <User key> --region <region>

Important

Make sure to replace the <profile name>, the <User key>, and the region (either us or eu) with real values.

Profiles let you select which New Relic account you want to run commands against. If you have multiple accounts, you can view them with profiles:list:

bash
$
nr1 profiles:list

Notice that one profile is your default profile. This is the account your commands will run against, unless you specify another. To specify a profile for a particular command, use the --profile option:

bash
$
nr1 create --profile <your profile>

If this is your first time using the CLI, then the profile you just added is your default profile. If you have other profiles, you need to set your default to the one you'd like to use for this course:

bash
$
nr1 profiles:default

Tip

If you forget these commands, you can look them up in the profiles help menu:

bash
$
nr1 profiles --help

Now, you’re ready to build an application with the New Relic One CLI.

Course

This lesson is part of a course that teaches you how to build a New Relic One application from the ground up. Continue on to the next lesson: Create a Nerdpack.