Skip to content

docs: Fix README CLI commands and Python API examples#15

Merged
KellyJDavis merged 1 commit into
mainfrom
readme-fix
Nov 29, 2025
Merged

docs: Fix README CLI commands and Python API examples#15
KellyJDavis merged 1 commit into
mainfrom
readme-fix

Conversation

@KellyJDavis

Copy link
Copy Markdown
Owner
  • Fix CLI command syntax (--pkg→--package, start→serve, etc.)
  • Fix Python API field names (results.items→results.results)
  • Correct server port (8000→8001) and add /api/v1 path
  • Remove non-existent --backend flag from search command
  • Fix configure api-key to use --api-key flag properly
  • Add missing asyncio.run() wrappers in examples
  • Fix all field access patterns to match actual models

All examples now accurately reflect the implementation.

- Fix CLI command syntax (--pkg→--package, start→serve, etc.)
- Fix Python API field names (results.items→results.results)
- Correct server port (8000→8001) and add /api/v1 path
- Remove non-existent --backend flag from search command
- Fix configure api-key to use --api-key flag properly
- Add missing asyncio.run() wrappers in examples
- Fix all field access patterns to match actual models

All examples now accurately reflect the implementation.
@KellyJDavis KellyJDavis merged commit 52fbf6e into main Nov 29, 2025
3 checks passed
@KellyJDavis KellyJDavis deleted the readme-fix branch November 29, 2025 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant