Skip to content

Document all eleven public SDK entrypoints #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
0thernet merged 2 commits into from
Oct 19, 2026
Merged

Document all eleven public SDK entrypoints #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebdf3d2
docs: list every public SDK entrypoint
0thernet Oct 19, 2026
a4cc82e
Merge remote-tracking branch 'origin/main' into codex/docs-sdk-entryp…
0thernet Oct 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,15 +322,19 @@ const plugin = candidate satisfies ProviderPluginDefinitionV1
void plugin
```

The package exposes nine public TypeScript entrypoints. Its root exposes
The package exposes eleven public TypeScript entrypoints. Its root exposes
programmatic plugin types and strict validators.
`@hraness/ghostget/client` exposes persistent-read and strict live-invocation
helpers, `@hraness/ghostget/beeper` exposes the body-free Beeper contact
interaction export, `@hraness/ghostget/apple-photos` exposes exact local Photos
contact evidence, `@hraness/ghostget/whatsapp` exposes the private
TextButler export, `@hraness/ghostget/omni` exposes normalized
cross-provider reads, and `@hraness/ghostget/messaging` exposes agentic messaging
route discovery and resolution, `@hraness/ghostget/messaging-automation` exposes the trusted owner messaging host, and `@hraness/ghostget/contracts` exposes the machine-checkable contract parsers and schemas. Importing any SDK entrypoint does not start the CLI.
route discovery and resolution, `@hraness/ghostget/messaging-automation` exposes the trusted owner messaging host, and `@hraness/ghostget/contracts` exposes the machine-checkable contract parsers and schemas.
`@hraness/ghostget/media-acquisition` provides temporary media acquisition and
cleanup, and `@hraness/ghostget/pdf-acquisition` provides signed-in PDF capture
with optional typed native process supervision. Both acquisition helpers require
Bun. Importing any SDK entrypoint does not start the CLI.
Importing the package root also does not inspect local state or load provider
runtimes.

Expand Down
2 changes: 1 addition & 1 deletion website/source/docs-tutorials-getting-started.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ <h2 id="sdk">Use GhostGet from TypeScript</h2>
}

const plugin = candidate satisfies ProviderPluginDefinitionV1</code></pre></div>
<p>The package has nine public TypeScript entrypoints: <code>@hraness/ghostget</code> for plugin types and validators, <code>@hraness/ghostget/client</code> for saved reads and live calls, <code>@hraness/ghostget/beeper</code> for contact interactions without message bodies, <code>@hraness/ghostget/apple-photos</code> for local Photos contact evidence, <code>@hraness/ghostget/whatsapp</code> for the private export to TextButler, <code>@hraness/ghostget/omni</code> for normalized cross-provider reads, <code>@hraness/ghostget/messaging</code> for agentic route discovery and resolution, <code>@hraness/ghostget/messaging-automation</code> for the trusted owner host and its protocol types, and <code>@hraness/ghostget/contracts</code> for checking a read-only collection plan against the installed actions before any provider is contacted. Importing any of them starts nothing and makes no network request in Node or Bun; constructing an automation host requires Bun and explicit provider setup. Use <code>ghostget messaging automation serve --stdio</code> for built-in account and managed-permission enforcement. See the <a href="{{GHOSTGET_REPOSITORY}}/blob/{{GHOSTGET_RELEASE}}/docs/messaging-automation.md">owner messaging guide</a> before granting authority.</p>
<p>The package has eleven public TypeScript entrypoints: <code>@hraness/ghostget</code> for plugin types and validators, <code>@hraness/ghostget/client</code> for saved reads and live calls, <code>@hraness/ghostget/beeper</code> for contact interactions without message bodies, <code>@hraness/ghostget/apple-photos</code> for local Photos contact evidence, <code>@hraness/ghostget/whatsapp</code> for the private export to TextButler, <code>@hraness/ghostget/omni</code> for normalized cross-provider reads, <code>@hraness/ghostget/messaging</code> for agentic route discovery and resolution, <code>@hraness/ghostget/messaging-automation</code> for the trusted owner host and its protocol types, <code>@hraness/ghostget/contracts</code> for checking a read-only collection plan against the installed actions before any provider is contacted, <code>@hraness/ghostget/media-acquisition</code> for temporary media acquisition and cleanup, and <code>@hraness/ghostget/pdf-acquisition</code> for signed-in PDF capture with optional typed native process supervision. Importing any of them starts nothing and makes no network request in Node or Bun; constructing an automation host requires Bun and explicit provider setup, and both acquisition helpers require Bun. Use <code>ghostget messaging automation serve --stdio</code> for built-in account and managed-permission enforcement. See the <a href="{{GHOSTGET_REPOSITORY}}/blob/{{GHOSTGET_RELEASE}}/docs/messaging-automation.md">owner messaging guide</a> before granting authority.</p>
</section>

<section aria-labelledby="developer-resources">
Expand Down
Loading