Ship the Nutrient CLI and DWS authentication flow - #20
Ship the Nutrient CLI and DWS authentication flow#20vladimir-tikhonov-nutrient wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces a new top-level nutrient CLI entry point for account/auth management while keeping existing PDF conversion commands (pdf-to-markdown, pdf-to-text, query) intact and installable via the same npm/installer paths.
Changes:
- Added a
nutrientlauncher script and exposed it via npmbin, installer, and CI validation. - Updated the
pdf-to-markdownwrapper to support anutrientverb mode (viaNUTRIENT_WRAPPER_VERB) and to install/exec an appropriate verb symlink. - Updated documentation and licensing text to describe account connection, plan credits, Vision entitlement, and privacy/usage metadata.
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Documents the new nutrient auth … workflow, plan/credit model, and privacy/licensing details. |
| package.json | Exposes nutrient as an additional npm-installed executable and extends the check script. |
| LICENSE.md | Updates license terms to describe basic use, account plans, Vision eligibility, and usage metadata. |
| install.sh | Installs the new nutrient wrapper alongside existing command wrappers. |
| docs/benchmarks.md | Updates benchmark notes to reflect paid-plan Vision positioning and authentication requirements. |
| CHANGELOG.md | Adds an Unreleased entry summarizing the new nutrient entry point and auth/plan features. |
| bin/pdf-to-markdown | Adds verb selection for nutrient mode and adjusts update-check/link behavior accordingly. |
| bin/nutrient | New wrapper that routes nutrient … invocations through the existing pdf-to-markdown wrapper. |
| .github/workflows/validate.yml | Extends ShellCheck and install validation to include the new bin/nutrient wrapper. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
025ef86 to
059d2c7
Compare
ce0726e to
eda5fcc
Compare
|
Added guides on the intended flows that I operated with for OAuth and anonymous/guest organizations: https://github.com/PSPDFKit/PSPDFKit/blob/master/hosted/docs/guest/pdf-to-markdown-cli-oauth.md Includes sections about fingerprinting (enforcement is WIP on hosted side). If anything looks wrong, unclear or missing let me know - device auth and guest orgs are not used yet on production so we have a lot of leeway to change the direction at this point. |
eda5fcc to
1478127
Compare
The npm package and installer expose a new
nutriententry point for account management while preserving the existing conversion commands and installation paths.Business decisions
--api-keyorNUTRIENT_API_KEY.Technical decisions
nutrient auth login,status, andlogoutalongside the existing wrappers without changing checksum verification, download locking, or platform selection.pdf-to-markdown,pdf-to-text,query, npm, and shell-installer entry points remain valid.Context: DWS-331