@hyperdx/cli 0.1.1 → 0.1.3

package/README.md

@@ -1,32 +1,40 @@
-# Command Line Interface for HyperDX
+# @hyperdx/cli
 
-## Uploading source maps to HyperDX
+Command line interface for HyperDX.
 
-In your build pipeline, you will need to run the CLI tool. Here's how to run it:
+## Uploading Source Maps
 
-```sh
-npx @hyperdx/cli upload-sourcemaps --path="/path/to/sourcemaps" --serviceKey="your-service-account-api-key"
+Upload JavaScript source maps to HyperDX for stack trace de-obfuscation.
+
+In your build pipeline, run the CLI tool:
+
+```bash
+npx @hyperdx/cli upload-sourcemaps \
+  --serviceKey "$HYPERDX_API_ACCESS_KEY" \
+  --apiUrl "$HYPERDX_API_URL" \
+  --path .next \
+  --releaseId "$RELEASE_ID"
 ```
 
-You can also add this as an npm script
+You can also add this as an npm script:
 
 ```json
-// In package.json
-
 {
   "scripts": {
-    "upload-sourcemaps": "npx @hyperdx/cli upload-sourcemaps --path=\"/path/to/sourcemaps\""
+    "upload-sourcemaps": "npx @hyperdx/cli upload-sourcemaps --path=\".next\""
   }
 }
 ```
 
-Optionally, you can set the `HYPERDX_SERVICE_KEY` environment variable to avoid passing the `serviceKey` flag.
+### Options
 
-## Contributing
+| Flag                      | Description                                            | Default |
+| ------------------------- | ------------------------------------------------------ | ------- |
+| `-k, --serviceKey <key>`  | HyperDX service account API key                        |         |
+| `-p, --path <dir>`        | Directory containing sourcemaps                        | `.`     |
+| `-u, --apiUrl <url>`      | HyperDX API URL (required for self-hosted deployments) |         |
+| `-rid, --releaseId <id>`  | Release ID to associate with the sourcemaps            |         |
+| `-bp, --basePath <path>`  | Base path for the uploaded sourcemaps                  |         |
 
-You can test your changes locally by running the following commands:
-
-```sh
-yarn build
-node dist/index.js upload ...
-```
+Optionally, set the `HYPERDX_SERVICE_KEY` environment variable to avoid passing
+the `--serviceKey` flag.