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

Ouverte Adaptée aux débutants
#8,715 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 2 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
84/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Domaine
documentation

Piste de recherche

Lisez docs/guide/index.md autour des lignes 1332–1345, où sont documentés les options de lancement de la CLI et le cas particulier de macOS. Vérifiez à quelles éditions s’appliquent -n et --new-instance en vous appuyant sur la reproduction de l’issue avec l’édition Free. Le travail est terminé lorsque le guide indique clairement si ces options s’appliquent aux utilisateurs de Free.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.
Langage dominant
C++
Étoiles
1.3k
Forks
304
Merge moyen
2 j 20 h
PR mergées (30 j)
10

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de Vector35/binaryninja-api

Toutes les issues de Vector35/binaryninja-api

Issues similaires

Plus d'issues C++

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.