Skip to content

docs(cli): --type elf still requires --uuid in 0.8.0 - #75

Merged
krassx merged 1 commit into
mainfrom
krassx/cli-elf-uuid-required-e15a
Oct 8, 2026
Merged

krassx merged 1 commit into
mainfrom
krassx/cli-elf-uuid-required-e15a

Conversation

@krassx

@krassx krassx commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

The 0.8.0 CLI docs (PR #74) showed --type elf directory / native-debug-symbols.zip examples without --uuid. That does not match the published @bugsee/cli 0.8.0 binary.

This is a docs mismatch, not a CLI bug: 0.8.0 keys each library by GNU build-id, but --uuid (the SDK BUILD_UUID) is still required and only correlates logs. Omitting it was not an intended 0.8.0 change.

Evidence

Installed @bugsee/cli@0.8.0 from npm (bugsee-cli 0.8.0). Dry-ran against a real aarch64 ELF (libsymbol1.so, GNU build-id bca64abfec40dbb631bb8f1c37414472) as both a directory and a native-debug-symbols.zip.

Input --uuid Exit Result
directory of .so omitted 20 configuration error: --uuid is required when --type elf (the resolved BUILD_UUID from the SDK's asset channel)
directory of .so supplied 0 dry-run: would register + upload 1 libraries
native-debug-symbols.zip omitted 20 same configuration error
native-debug-symbols.zip supplied 0 dry-run: would register + upload 1 libraries
--extension so.debug,dbg (docs example) omitted 20 same configuration error
--extension so.debug,dbg supplied 0 dry-run success
directory + zip mixed omitted 20 same configuration error
directory + zip mixed supplied 0 dry-run success (one uploadable library after build-id dedup)

The --uuid check runs before path scanning: an empty directory without --uuid is also exit 20, not 10.

Commands (representative):

npx --yes @bugsee/cli@0.8.0 --version   # bugsee-cli 0.8.0

# directory, no --uuid → 20
bugsee-cli debug-files upload ./libs --type elf --version 1.4.0 --build 1400 --dry-run

# directory, with --uuid → 0
bugsee-cli debug-files upload ./libs --type elf --version 1.4.0 --build 1400 \
  --uuid 6ba7b811-9dad-11d1-80b4-00c04fd430c8 --dry-run

# zip, no --uuid → 20
bugsee-cli debug-files upload ./native-debug-symbols.zip --type elf \
  --version 1.4.0 --build 1400 --dry-run

# zip, with --uuid → 0
bugsee-cli debug-files upload ./native-debug-symbols.zip --type elf \
  --version 1.4.0 --build 1400 --uuid 6ba7b811-9dad-11d1-80b4-00c04fd430c8 --dry-run

Why this is intended 0.8.0 behaviour

  • bugsee-cli debug-files upload --help (0.8.0): --uuid is Required for --type elf.
  • CLI README (v0.8.0): --uuid (the SDK's BUILD_UUID) is still required but only correlates logs.
  • Source (src/cli/debug_files.rs): config_invalid("--uuid is required when --type elf …"); run_elf_upload logs build_uuid for correlation only.
  • Integration test uuid_override_is_required_for_elf in tests/debug_files_flags.rs asserts exit 20.
  • 0.8.0 changelog adds directory input; it does not drop the --uuid requirement.

Docs changes

  • docs/cli/debug-files.md: add --uuid to every --type elf example (directory, zip, --extension); mark it required in the options table; state that it is required (exit 20) and that GNU build-id remains the per-library key.
  • docs/cli/release-notes.md: 0.8.0 ELF note now says --uuid is still required.

No other pages changed.

Checked

  • npx cspell "docs/**/*.md" "docs/**/*.mdx" --no-cache -c cspell.json: 0 issues (294 files).
  • node scripts/sync-skills.mjs && npm run build && node scripts/copy-raw-markdown.mjs: succeeds.
Open in Web Open in Cursor 

The published @bugsee/cli 0.8.0 binary rejects --type elf without --uuid
(exit 20). Directory and zip inputs are keyed by GNU build-id, but the
flag remains required for the SDK BUILD_UUID. Match the examples and
option table to that behaviour.

Co-authored-by: Alexey Karimov <krassx@users.noreply.github.com>
@krassx
krassx marked this pull request as ready for review October 8, 2026 03:26
@krassx
krassx merged commit bdc17a7 into main Oct 8, 2026
1 check passed
@krassx
krassx deleted the krassx/cli-elf-uuid-required-e15a branch October 8, 2026 03:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants