To build a New Relic app, you must install the New Relic One CLI. The CLI helps you build, publish, and manage your New Relic app.
We provide a variety of tools for building apps, including the New Relic One CLI (command line interface). This page explains how to use CLI commands to:
Generate Nerdpack/Nerdlet templates
Locally serve Nerdpacks (when developing)
Publish and deploy
Subscribe to Nerdpacks
Add screenshots and metadata to the catalog
Installing the New Relic One CLI
In New Relic, click Instant Observability, then check the Apps box in the filter by section. Click the Build on New Relic launcher and follow the quick start instructions. The quick start automatically generates an API key for the account you select, and gives you the pre-populated commands to create a profile, generate your first "Hello World" app, and serve it locally.
Use the NR1 VS Code extension to build your apps.
New Relic One CLI Commands
This table provides descriptions for the New Relic app commands. For more context, including usage and option details, click any individual command or the command category.
For details on user permissions, see Permissions.
For more on how to serve and publish your application, see our guide on Deploying your New Relic app.
|Shows all |
|Updates to the latest version of the CLI.|
|Creates a new component from a template (Nerdpack, Nerdlet, launcher, or catalog).|
|Manages the profiles you use to run CLI commands.|
|Displays autocomplete installation instructions.|
|Fetches data using NRQL (New Relic query language).|
Configure your CLI preferences
|Sets a specific configuration value.|
|Shows a specific configuration.|
|Lists your configuration choices.|
|Removes the value of a specific configuration.|
Set up your Nerdpacks
|Assembles your Nerdpack into bundles.|
|Clones an open source Nerdpack from our GitHub repository.|
|Serves your Nerdpack for testing and development purposes.|
|Shows or regenerates the UUID of a Nerdpack.|
|Publishes your Nerdpack to New Relic.|
|Deploys a Nerdpack version to a specific channel.|
|Undeploys a Nerdpack version from a specific channel.|
|Cleans your developtment folders.|
|Validates the contents of your Nerdpack.|
|Shows the state of your Nerdpack in the New Relic's registry.|
Manage your Nerdpack subscriptions
|Subscribes your account to a Nerdpack and channel.|
|Lists all the Nerdpacks your account is subscribed to.|
|Unsubscribes your account from a Nerdpack.|
Install and manage plugins
|Installs a plugin into the CLI.|
|Links a plugin into the CLI for development.|
|Updates your installed plugins.|
|Removes a plugin from the CLI.|
Manage catalog information
|Shows the Nerdpack info stored in the catalog.|
|Gathers and submits the catalog info on the current folder.|