fix(docs): CLI instance flags are rejected by the Free edition

未關閉 適合新手
#8,715 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 2 天內回覆

還沒有人認領這個 Issue。

評估

難度
1/5
預估耗時
1 小時以內
新手友好度
84/100
Issue 類型
文件
描述清晰度
描述清楚
活躍度
活躍
領域
documentation

研究方向

閱讀 docs/guide/index.md 第 1332–1345 行附近的內容,這裡記錄了 CLI 啟動旗標和 macOS 注意事項。根據 issue 中 Free 版的重現情況,確認 -n 和 --new-instance 適用於哪些版本。完成標準是指南明確說明這些旗標是否適用於 Free 使用者。

由索引模型根據 Issue 內容生成。

描述

Summary

The user guide documents -n and --new-instance without a Free-edition exception, but the current Linux Free executable rejects both options and exits before launching. Following this guidance therefore fails for Free users. This report concerns the guide's edition applicability; it does not establish a defect in the paid-edition parser or require Free to implement these options.

Runtime or environment

  • Binary Ninja: 6.0.10905 free, Linux x86_64; --version reports Binary Ninja 6.0.10905 free. This matches the latest published stable release and the version in the official artifact hash list.
  • OS: Omarchy 4.5.0 (Arch-based Linux), x86_64; Qt Wayland backend, isolated home, XDG configuration/data/cache directories, and BN_USER_DIRECTORY.
  • Executable SHA-256: 591f289b903fad4690ffce487bd0b38f613fd4d9da4f6beb36a4e941f75718a0.
  • Current default-branch documentation: dev at 74749a72a606532e3984b605518bd49094020699. Stable guide source: 775c3b5eed8598217b20e1087afe7aa092a9b4b1. Both contain the same unqualified instance-flag guidance. The proprietary development executable and paid editions were not tested.

Steps to reproduce

Using the tested Free build on a functioning desktop session, run these commands from the extracted application directory, with no analysis input required:

./binaryninja --version
./binaryninja --help
./binaryninja -n
./binaryninja --new-instance

Each invocation was run separately with disposable user/configuration directories. No input binary or plugin is needed.

Expected behavior

The command-line launch guidance should accurately identify which editions accept its instance flags. If Free intentionally omits these options, the guide should make that restriction clear so Free users can select applicable launch instructions. Alternatively, accepting the documented flags in Free would resolve the discrepancy. Paid-edition behavior and the intended Free instance-management policy remain for the project to determine.

Actual behavior

Both instance-flag invocations exit with status 1:

$ ./binaryninja -n
Binary Ninja: Unknown option 'n'.

$ ./binaryninja --new-instance
Binary Ninja: Unknown option 'new-instance'.

The --version and --help controls exit with status 0. The help lists -h/--help, --help-all, -v/--version, -p, -d/--debug, -l/--debug-log, -e/--stderr-log, and -w/--reset-ui-window-settings; neither instance flag appears. The guide includes a macOS caveat but no Free caveat in this section.

Evidence

Restoration check

Repeat the commands against the edition to which the guide applies. The guide must either clearly exclude Free from the unsupported instance-flag instructions, or the Free parser must accept those documented options and provide the promised behavior. A documentation-only correction need not change the Free parser. Retain the version/help controls when checking runtime behavior.

References

  • URL handling code messes with CLI usage, #7488 is closed and records the addition of instance-flag documentation. This report concerns the remaining Free-edition applicability gap, without asserting a shared implementation cause.

Triage assessment

  • Impact level: P2
  • Assessment status: supported
  • Impact basis: Following the documented launch options in the tested Free edition aborts startup with a nonzero exit, rather than launching the requested instance. The failure is bounded to these instructions and does not establish that ordinary Free analysis is broken.
  • Workaround status: available
  • Workaround basis: The shipped help provides the applicable option list, so Free users can avoid the rejected flags. This bypass avoids the parser error but does not claim equivalent forced-instance semantics.
主要語言
C++
星號
1.3k
分支
304
平均合併
2 天 20 小時
30 天內合併 PR
10

環境準備

這個專案沒有提供開發容器、Dockerfile 或貢獻指南,環境需要你自己搭建:先看它的 README,通用步驟見我們的新手貢獻指南。

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

Vector35/binaryninja-api 的其他 Issue

查看 Vector35/binaryninja-api 的全部 Issue

相似的 Issue

更多 C++ Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。