From c8da07a953f0e43e9f9033e0c62a754737120cf6 Mon Sep 17 00:00:00 2001 From: s1gr1d <32902192+s1gr1d@users.noreply.github.com> Date: Tue, 21 Apr 2026 17:26:08 +0200 Subject: [PATCH] docs(readme): Update usage instructions for binary scripts --- packages/profiling-node/README.md | 12 +++++++++--- packages/remix/README.md | 9 +++++++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/packages/profiling-node/README.md b/packages/profiling-node/README.md index 962bc8e6834f..51e447640c14 100644 --- a/packages/profiling-node/README.md +++ b/packages/profiling-node/README.md @@ -239,13 +239,19 @@ the binaries will be copied. This is wasteful as you will likely only need one o runtime. To prune the other libraries, profiling-node ships with a small utility script that helps you prune unused binaries. The -script can be invoked via `sentry-prune-profiler-binaries`, use `--help` to see a list of available options or -`--dry-run` if you want it to log the binaries that would have been deleted. +script can be invoked via `sentry-prune-profiler-binaries`: + +```bash +npx --package=@sentry/profiling-node sentry-prune-profiler-binaries +``` + +Use `--help` to see a list of available options or `--dry-run` if you want it to log the binaries that would have been +deleted. Example of only preserving a binary to run node16 on linux x64 musl. ```bash -sentry-prune-profiler-binaries --target_dir_path=./dist --target_platform=linux --target_node=16 --target_stdlib=musl --target_arch=x64 +npx --package=@sentry/profiling-node sentry-prune-profiler-binaries --target_dir_path=./dist --target_platform=linux --target_node=16 --target_stdlib=musl --target_arch=x64 ``` Which will output something like diff --git a/packages/remix/README.md b/packages/remix/README.md index 9260def2b700..2589ed9f7e6b 100644 --- a/packages/remix/README.md +++ b/packages/remix/README.md @@ -122,8 +122,13 @@ Sentry.captureEvent({ The Remix SDK provides a script that automatically creates a release and uploads sourcemaps. To generate sourcemaps with Remix, you need to call `remix build` with the `--sourcemap` option. -On release, call `sentry-upload-sourcemaps` to upload source maps and create a release. To see more details on how to -use the command, call `sentry-upload-sourcemaps --help`. +On release, call `sentry-upload-sourcemaps` to upload source maps and create a release: + +```bash +npx --package=@sentry/remix sentry-upload-sourcemaps +``` + +To see more details on how to use the command, call `npx --package=@sentry/remix sentry-upload-sourcemaps --help`. For more advanced configuration, [directly use `sentry-cli` to upload source maps.](https://github.com/getsentry/sentry-cli).