docs: add CLI reference and extractor docs for nexuslims extract#101
Merged
docs: add CLI reference and extractor docs for nexuslims extract#101
Conversation
jat255
added a commit
that referenced
this pull request
Apr 1, 2026
Documents the `nexuslims extract` command in cli_reference.md and extractors.md, and corrects the help text in extract.py to accurately describe where output files are written (alongside the input file, not the NexusLIMS data directory, unless the file is under NX_INSTRUMENT_DATA_PATH).
jat255
force-pushed
the
docs/extract-cli-reference
branch
from
86c6359 to
32c76d0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
nexuslims extractsection todocs/user_guide/cli_reference.mdwith usage, all options, exit codes, and examplesCommand-Line Extractionsection todocs/user_guide/extractors.mdcross-linked from the CLI referencenexusLIMS/cli/extract.py: the default preview and--writeJSON output go alongside the input file, not intoNX_DATA_PATH, unless the file is underNX_INSTRUMENT_DATA_PATHextractdocs/changes/96.doc.mdTest plan
./scripts/build_docs.sh --skip-tui-demosand confirm no warningsnexuslims extract --helpoutput matches the updated help stringsnexuslims extract <file>writes preview alongside the file as expected