--- title: Nerdpack commands source: https://docs.newrelic.com/docs/new-relic-solutions/build-nr-ui/nr1-cli/nr1-nerdpack --- Use the commands below to set up your Nerdpacks. You can click on any command to see its usage options and additional details about the command. | Command | Description | | ------------------------------------------------ | ------------------------------------------------------------ | | [`nr1 nerdpack:build`](#nr1-nerdpackbuild) | Builds a Nerdpack | | [`nr1 nerdpack:clean`](#nr1-nerdpackclean) | Removes all built artifacts. | | [`nr1 nerdpack:clone`](#nr1-nerdpackclone) | Clones a Nerdpack from a git repository | | [`nr1 nerdpack:info`](#nr1-nerdpackinfo) | Shows the state of your Nerdpack in the New Relic's registry | | [`nr1 nerdpack:publish`](#nr1-nerdpackpublish) | Publish this Nerdpack | | [`nr1 nerdpack:serve`](#nr1-nerdpackserve) | Serves your Nerdpack for testing and development purposes | | [`nr1 nerdpack:tag`](#nr1-nerdpacktag) | Tags a specific Nerdpack version | | [`nr1 nerdpack:untag`](#nr1-nerdpackuntag) | Removes a tag from the registry | | [`nr1 nerdpack:uuid`](#nr1-nerdpackuuid) | Shows or regenerates the UUID of a Nerdpack | | [`nr1 nerdpack:validate`](#nr1-nerdpackvalidate) | Validates artifacts inside your Nerdpack | ## `nr1 nerdpack:build` [#nr1-nerdpackbuild] Builds a nerdpack. ### Usage [#build-usage] ```sh nr1 nerdpack:build ``` ### Options [#build-options] | `--extra-metadata-path=extra-metadata-path` | `default: extra-metadata.json` specify a json file path with extra metadata. | | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--prerelease=prerelease` | If specified, the value will be appended to the current version of generated files. For example `--prerelease=abc`. Then the version will be `1.2.3-abc`. | | `--profile=profile` | The authentication profile you want to use. | | `--verbose` | Adds extra information to the output. | ### Description [#build-description] Runs a webpack process to assemble your Nerdpack into javascript and css bundles. As many other CLI commands, it should be run at the `package.json` level of your Nerdpack. It will search for `nr1.json` files in your subdirectories, validate them, and try to build them. This also runs `nr1 nerdpack:validate` before starting the build process. ## `nr1 nerdpack:clean` [#nr1-nerdpackclean] Removes all built artifacts ### Usage [#clean-usage] ```sh nr1 nerdpack:clean ``` ### Options [#clean-options] | `--profile=profile` | The authentication profile you want to use. | | ------------------- | ------------------------------------------- | | `--verbose` | Adds extra information to the output. | ### Description [#clean-description] Cleans and removes the content and the development folders (`dist/`, `tmp/`). ## `nr1 nerdpack:clone` [#nr1-nerdpackclone] Clones a nerdpack from a git repository. ### Usage [#clone-usage] ```sh nr1 nerdpack:clone ``` ### Options [#clone-options] | `-f`, `--force` | Replace destination folder if it exists. | | ------------------- | ----------------------------------------------------------------------- | | `-p`, `--path=path` | Directory where to clone (defaults to the repository name). | | `-r`, `--repo=repo` | This is **required**. Repository location, either an HTTPS or SSH path. | | `--profile=profile` | The authentication profile you want to use. | | `--verbose` | Adds extra information to the output. | ### Description [#clone-description] Given a git repository, it performs all the actions so that you can start using it. This includes, in order: 1. Clone the repository. 2. Set the repository as remote upstream. 3. Install all of its dependencies, using `npm`. 4. Generate a new UUID using your profile, and commit it. ## `nr1 nerdpack:info` [#nr1-nerdpackinfo] Shows the state of your nerdpack in the new relic's registry. ### Usage [#info-usage] ```sh nr1 nerdpack:info ``` ### Options [#info-options] | `-a`, `--all` | Show all versions. | | --------------------------------- | ---------------------------------------------------------- | | `-i`, `--nerdpack-id=nerdpack-id` | Get info from the specified Nerdpack instead of local one. | | `--profile=profile` | The authentication profile you want to use. | | `--verbose` | Adds extra information to the output. | ### Description [#info-description] The default amount of versions shown is 10 but all versions can be shown if the `--all` or `-a` flag is used. ## `nr1 nerdpack:publish` [#nr1-nerdpackpublish] Publish this nerdpack. ### Usage [#publish-usage] ```sh nr1 nerdpack:publish ``` ### Options [#publish-options] | `-B`, `--skip-build` | Skip the previous build process. | | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `-T`, `--skip-tag` | Do not tag the version. | | `-t`, `--tag=tag` | `default: STABLE` | | `--dry-run` | Publish process without actually publishing anything. | | `--extra-metadata-path=extra-metadata-path` | `default: extra-metadata.json` specify a json file path with extra metadata. | | `--prerelease=prerelease` | If specified, the value will be appended to the current version of generated files. For example, `--prerelease=abc`. Then the version will be `1.2.3-abc`. | | `--profile=profile` | The authentication profile you want to use. | | `--verbose` | Adds extra information to the output. | ### Description [#publish-description] This command will build and upload your Nerdpack to the registry. If no additional parameters are passed in, this command will automatically tag the nerdpack version as `STABLE`. If you want to disable this behavior, pass the `--skip-tag` flag to the command. See `nr1 nerdpack:tag --help` for more info on tags. ## `nr1 nerdpack:serve` [#nr1-nerdpackserve] Serves your nerdpack for testing and development purposes. ### Usage [#serve-usage] ```sh nr1 nerdpack:serve ``` ### Options [#serve-options] | `--profile=profile` | The authentication profile you want to use. | | ------------------- | ------------------------------------------- | | `--verbose` | Adds extra information to the output. | ### Description [#serve-description] Launches a server with your local code, ready to be tested live on the platform. ## `nr1 nerdpack:tag` [#nr1-nerdpacktag] Tags a specific nerdpack version. ### Usage [#tag-usage] ```sh nr1 nerdpack:tag ``` ### Options [#tag-options] | `-V`, `--from-version=from-version` | Version to tag. If it's not provided will use the one in `package.json`. | | ----------------------------------- | ----------------------------------------------------------------------------- | | `-i`, `--nerdpack-id=nerdpack-id` | Nerdpack uuid to deploy. If it's not provided will use the one in `nr1.json`. | | `-t`, `--tag=tag` | `default: STABLE` tag name | | `--profile=profile` | The authentication profile you want to use. | | `--verbose` | Adds extra information to the output. | ### Description [#tag-description] A single version may have several tags, but each tag can only be applied to one version. Tagging a different version with an existing tag will untag the previous one. We recommend using `STABLE` to tag the versions you want to show to your subscribers. See the command `nr1 nerdpack:subscribe` for more info. ### Aliases [#tag-aliases] ```sh $ nr1 nerdpack:deploy ``` ## `nr1 nerdpack:untag` [#nr1-nerdpackuntag] Removes a tag from the registry. ### Usage [#untag-usage] ```sh nr1 nerdpack:untag ``` ### Options [#untag-options] | `-i`, `--nerdpack-id=nerdpack-id` | Nerdpack uuid to deploy. If it's not provided will use the one in `nr1.json`. | | --------------------------------- | ----------------------------------------------------------------------------- | | `-t`, `--tag=tag` | `default: STABLE` tag name. | | `--profile=profile` | The authentication profile you want to use. | | `--verbose` | Adds extra information to the output. | ### Description [#untag-description] Specified tag will be removed. No files will be actually deleted. ### Aliases [#untag-aliases] ```sh $ nr1 nerdpack:undeploy ``` ## `nr1 nerdpack:uuid` [#nr1-nerdpackuuid] Shows or regenerates the uuid of a nerdpack. ### Usage [#uuid-usage] ```sh nr1 nerdpack:uuid ``` ### Options [#uuid-options] | `-f`, `--force` | If present, it will override the existing UUID without asking. | | ------------------- | -------------------------------------------------------------- | | `-g`, `--generate` | Generates a new UUID if not available. | | `--profile=profile` | The authentication profile you want to use. | | `--verbose` | Adds extra information to the output. | ### Description [#uuid-description] By default, prints the universal unique ID of the specified package. It also enables generation or regeneration of the UUID of your package, depending on the flags passed. ## `nr1 nerdpack:validate` [#nr1-nerdpackvalidate] Validates artifacts inside your nerdpack. ### Usage [#validate-usage] ```sh nr1 nerdpack:validate ``` ### Options [#validate-options] | `-l`, `--force-local` | Do not download new schema files. | | ---------------------- | ------------------------------------------- | | `-r`, `--force-remote` | Force download of new schema files. | | `--profile=profile` | The authentication profile you want to use. | | `--verbose` | Adds extra information to the output | ### Aliases [#validate-aliases] ```sh nr1 nerdpack:ls ``` ```sh nr1 nerdpack:val ```