mirror of https://github.com/hyperdxio/hyperdx synced 2026-04-21 13:37:15 +00:00

History

github-actions[bot] f086842f3c Some checks are pending Knip - Unused Code Analysis / knip (push) Waiting to run Details Main / lint (push) Waiting to run Details Main / unit (push) Waiting to run Details Main / integration (push) Waiting to run Details Main / otel-unit-test (push) Waiting to run Details Main / otel-smoke-test (push) Waiting to run Details Main / e2e-tests (push) Waiting to run Details Main / End-to-End Tests (push) Blocked by required conditions Details Main / ClickHouse Bundle Build (push) Waiting to run Details Push Downstream / push-downstream (push) Waiting to run Details Release / Build OTel Collector (arm64) (push) Blocked by required conditions Details Release / Check Changesets (push) Waiting to run Details Release / Check if version exists (push) Blocked by required conditions Details Release / Build OTel Collector (amd64) (push) Blocked by required conditions Details Release / Publish OTel Collector Manifest (push) Blocked by required conditions Details Release / Build App (amd64) (push) Blocked by required conditions Details Release / Build App (arm64) (push) Blocked by required conditions Details Release / Publish App Manifest (push) Blocked by required conditions Details Release / Build Local (amd64) (push) Blocked by required conditions Details Release / Build Local (arm64) (push) Blocked by required conditions Details Release / Publish Local Manifest (push) Blocked by required conditions Details Release / Build All-in-One (amd64) (push) Blocked by required conditions Details Release / Build All-in-One (arm64) (push) Blocked by required conditions Details Release / Publish All-in-One Manifest (push) Blocked by required conditions Details Release / Release CLI Binaries (push) Blocked by required conditions Details Release / Notify Helm-Charts Downstream (push) Blocked by required conditions Details Release / Notify CH Downstream (push) Blocked by required conditions Details Release / notify_clickhouse_clickstack (push) Blocked by required conditions Details Release / OpenTelemetry Export Trace (push) Blocked by required conditions Details Release HyperDX (#2097 ) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>		2026-04-20 00:00:40 -07:00
..
src	feat: Add additional alert threshold types (#2122 )	2026-04-16 15:47:04 +00:00
.gitignore	[HDX-3919] Add @hyperdx/cli package — terminal TUI, source map upload, and agent-friendly commands (#2043 )	2026-04-09 20:21:34 +00:00
AGENTS.md	[HDX-3978] Add 'o' keybinding to open trace/span in browser from TUI (#2105 )	2026-04-13 22:29:41 +00:00
CHANGELOG.md	Release HyperDX (#2097 )	2026-04-20 00:00:40 -07:00
CONTRIBUTING.md	[HDX-3919] Add @hyperdx/cli package — terminal TUI, source map upload, and agent-friendly commands (#2043 )	2026-04-09 20:21:34 +00:00
eslint.config.mjs	[HDX-3919] Add @hyperdx/cli package — terminal TUI, source map upload, and agent-friendly commands (#2043 )	2026-04-09 20:21:34 +00:00
package.json	Release HyperDX (#2097 )	2026-04-20 00:00:40 -07:00
README.md	[HDX-3919] Add @hyperdx/cli package — terminal TUI, source map upload, and agent-friendly commands (#2043 )	2026-04-09 20:21:34 +00:00
tsconfig.json	[HDX-3919] Add @hyperdx/cli package — terminal TUI, source map upload, and agent-friendly commands (#2043 )	2026-04-09 20:21:34 +00:00
tsup.config.ts	[HDX-3919] Add @hyperdx/cli package — terminal TUI, source map upload, and agent-friendly commands (#2043 )	2026-04-09 20:21:34 +00:00

README.md

@hyperdx/cli

Command line interface for HyperDX.

Uploading Source Maps

Upload JavaScript source maps to HyperDX for stack trace de-obfuscation.

In your build pipeline, run the CLI tool:

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:

{
  "scripts": {
    "upload-sourcemaps": "npx @hyperdx/cli upload-sourcemaps --path=\".next\""
  }
}

Options

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

Optionally, set the HYPERDX_SERVICE_KEY environment variable to avoid passing the --serviceKey flag.