Skip to content

Commit d727b01

Browse files
committed
fix: Update ReadMe docs to include local recipe test instructions
1 parent 96b0562 commit d727b01

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

test/manual/readme.MD

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ To test local recipe changes with the New Relic CLI, you can use the `--recipePa
164164
Steps for Testing Local Recipe Changes
165165

166166
1) Locate Your Local Recipe:
167-
Ensure your local recipe is saved on your system. For example, assume the recipe file is located at ~/debian.yml on an EC2 instance.
167+
Ensure your local recipe is saved on your system. For example, assume the recipe file is located at `~/debian.yml` on an EC2 instance.
168168

169169
2) Modify the Guided Install Command:
170170
Replace the default guided install command from New Relic's UI with a custom command by specifying the actual recipe name and using the `--recipePath` flag to point to your local recipe file.
@@ -173,14 +173,15 @@ Example Command:
173173

174174
```bash
175175
curl -Ls https://download.newrelic.com/install/newrelic-cli/scripts/install.sh | bash && \
176-
sudo NEW_RELIC_API_KEY=<API-KEY> NEW_RELIC_ACCOUNT_ID=<ACC-ID> /usr/local/bin/newrelic install -n infrastructure-agent-installer --recipePath ~/debian.yml
176+
sudo NEW_RELIC_API_KEY=<API-KEY> NEW_RELIC_ACCOUNT_ID=<ACC-ID> /usr/local/bin/newrelic install -n infrastructure-agent-installer --recipePath ~/debian.yml # Add --debug for verbose logging
177177
```
178178

179179
## Explanation of Parameters:
180180

181181
NEW_RELIC_API_KEY: Replace <API-KEY> with your actual New Relic API key.
182182
NEW_RELIC_ACCOUNT_ID: Replace <ACC-ID> with your New Relic account ID.
183-
`-n <recipe-name>`: Specifies the name of the recipe (e.g., infrastructure-agent-installer).
184-
`--recipePath /path/to/your/local/recipe/file`: Specifies the path to your local recipe file (~/debian.yml in this case).
183+
`-n <recipe-name>`: Specifies the name of the recipe (e.g., `infrastructure-agent-installer`).
184+
`--recipePath /path/to/your/local/recipe/file`: Specifies the path to your local recipe file (`~/debian.yml` in this case).
185+
`--debug`: Optional flag to enable verbose logging for debugging purposes.
185186

186187
This approach allows you to test custom changes in your recipes locally before deploying them to production environments.

0 commit comments

Comments
 (0)