This page includes a list of the common commands you have to start with the New Relic One CLI. You can click any command to see its usage options and additional details about the command.
Command | Description |
|---|---|
Displays autocomplete installation instructions. | |
Creates a new component from a template: Nerdpack, Nerdlet, launcher, or catalog. | |
Shows all | |
Fetches data using NRQL. | |
Manages the profiles you use to run CLI commands. | |
Updates to the latest version of the CLI. |
nr1 autocomplete
By default, the command displays the autocomplete instructions for zsh. If you want instructions for bash, run nr1 autocomplete bash.
Usage
$ nr1 autocomplete
Arguments
| The shell type you want instructions for. |
Options
| Refreshes cache and ignores displaying instructions. |
Examples
$ nr1 autocomplete$ nr1 autocomplete zsh$ nr1 autocomplete bash$ nr1 autocomplete --refresh-cache
nr1 create
Creates a new component from our template, either a Nerdpack, Nerdlet, launcher, or catalog. The CLI will walk you through this process.
To learn more about Nerdpacks and their file structure, see Nerdpack file structure. For more on how to set up your Nerdpacks, see our Nerdpack CLI commands.
Usage
$ nr1 create
Options
| If present, overrides existing files without asking. |
| Names the component. |
| Specifies the component type. |
| The route to the component. |
| The authentication profile you want to use. |
| Adds extra information to the output. |
nr1 help
Shows all nr1 commands by default. To get details about a specific command, run nr1 help COMMAND_NAME.
Usage
$ nr1 help
Arguments
| The name of a particular command. |
Examples
$ nr1 help$ nr1 help nerdpack$ nr1 help nerdpack:deploy
nr1 nrql
Fetches data from databases using a NRQL query.
To learn more about NRQL and how to use it, see our NRQL docs.
Usage
$ nr1 nrql OPTION ...
Options
| This is required. The user account ID. |
| This is required. The NRQL query to run. |
| Displays the content without tabs or spaces. |
| The authentication profile you want to use. |
| Adds extra information to the output. |
nr1 profiles
Displays a list of commands you can use to manage your profiles. Run nr1 help profiles:COMMAND for more on their specific usages. You can have more than one profile, which is helpful for executing commands on multiple New Relic accounts.
To learn more about setting up profiles, see our Github workshop.
Usage
$ nr1 profiles:COMMAND
Commands
| Adds a new profile to your profiles keychain. |
| Chooses which profile should be default. |
| Lists the profiles on your keychain. |
| Removes a profile from your keychain. |
nr1 update
Updates to latest version of the CLI. You can specify which channel to update if you'd like.
Usage
$ nr1 update
Arguments
| The name of a particular channel. |
Examples
$ nr1 update$ nr1 update somechannel