Skip to content

docs: Clarify ii-commons CLI usage#2

Draft
liujuanjuan1984 wants to merge 1 commit into
mainfrom
agent/clarify-ii-commons-cli-usage
Draft

docs: Clarify ii-commons CLI usage#2
liujuanjuan1984 wants to merge 1 commit into
mainfrom
agent/clarify-ii-commons-cli-usage

Conversation

@liujuanjuan1984

Copy link
Copy Markdown
Collaborator

Summary

  • Makes ii-commons the primary command surface across the README, skill guide, API reference, and OpenAI agent prompt.
  • Keeps the human-facing cold-start prompt concise while avoiding source-path-oriented usage examples.
  • Aligns documentation around npm/npx CLI usage and global PATH diagnostics.
  • Deduplicates search payload option construction and adds PubMed filter coverage.

Why

The npm CLI is the expected retrieval interface. The docs should help humans cold-start an agent with the skill while guiding agents toward ii-commons ... instead of internal script paths.

Validation

  • Temporary-lockfile npm audit: 0 vulnerabilities
  • npm test
  • npm run pack:dry

@liujuanjuan1984 liujuanjuan1984 changed the title Clarify ii-commons CLI usage docs: Clarify ii-commons CLI usage Jul 8, 2026
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