Skip to content

Private transport internals, --json, addon routing options, and the README reference - #11

Merged
colinhacks merged 2 commits into
mainfrom
api-json-docs
Oct 5, 2026
Merged

colinhacks merged 2 commits into
mainfrom
api-json-docs

Conversation

@colinhacks

Copy link
Copy Markdown
Contributor

Closes the three items from the beta API audit and rewrites the README as the reference.

  • The transport module is private; the crate exports Microbe, Installation, Root, Error, Transport, TIMEOUT and DEFAULT_REGISTRY.
  • Installation and Root serialize (camelCase); the binary prints that shape with --json. Sweep checks it.
  • The addon takes scopedRegistries and auth options, mirroring the Rust setters; its smoke passes them.
  • README: install per audience, Rust API, Errors, command-line reference with exit codes, Node API with every option.

…EADME reference

- The transport module is private; the crate exports Microbe, Installation, Root,
  Error, Transport, TIMEOUT and DEFAULT_REGISTRY. Builds with in-binary TLS keep the
  host clients compiled but allow them dead.
- Installation and Root derive serde::Serialize, camel-cased; the binary prints that
  shape with --json. The package count line is singular for one package.
- The addon takes scopedRegistries and auth options, the setters the .npmrc keys
  build on; its smoke passes them.
- README: install for each audience, the Rust API with Transport and TIMEOUT, an
  Errors section, the command-line reference with output and exit codes, the Node
  API with every option, and the placement rules as a list.
Copilot AI balanced review requested due to automatic review settings October 5, 2026 21:51

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@colinhacks
colinhacks merged commit 01fd497 into main Oct 5, 2026
19 checks passed
@colinhacks
colinhacks deleted the api-json-docs branch October 5, 2026 21:54
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.

2 participants