docs: end-user README, portable skill, no em dashes#11
Merged
Conversation
Lead with what the tool decides and why, then install, the CLI with sample output, the library, and the agent skill, with an honest requirements and scope section.
Invoke the installed localctx command (with the bundled script as a fallback by relative path) instead of relying on a Claude-specific path variable, so the skill works across compatible agents. Describe the flat JSON fields.
OCR needs a normal macOS graphics environment and will not run in a headless sandbox that lacks one.
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.
Polishes the docs for people installing the package, and makes the skill portable across agents.
Changes
localctxCLI with sample output, the library API, and the agent skill. Adds an honest requirements and scope section (macOS, Vision needs a real graphics environment, large-document retrieval is out of scope).SKILL.md): invokes the installedlocalctxcommand, with the bundled script as a relative-path fallback, instead of relying on a Claude-specific path variable. Now works in Codex and other compatible agents. Documents the flat JSON fields (source,text,text_tokens,image_tokens,image).No code behavior changes. Verified locally: ruff, ruff format, mypy (strict), pytest (56).