https://github.com/harborclient/sdk
TypeScript definitions for HarborClient plugin development
https://github.com/harborclient/sdk
api harborclient sdk
Last synced: 6 days ago
JSON representation
TypeScript definitions for HarborClient plugin development
- Host: GitHub
- URL: https://github.com/harborclient/sdk
- Owner: harborclient
- Created: 2026-06-24T17:33:45.000Z (12 days ago)
- Default Branch: main
- Last Pushed: 2026-06-27T14:37:45.000Z (9 days ago)
- Last Synced: 2026-06-27T16:22:09.767Z (9 days ago)
- Topics: api, harborclient, sdk
- Language: TypeScript
- Homepage: https://harborclient.github.io/sdk/
- Size: 1.31 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# @harborclient/sdk
TypeScript definitions, utility modules, and React runtime helpers for [HarborClient](https://harborclient.com/) plugin development.
**Documentation:** [https://harborclient.github.io/sdk/](https://harborclient.github.io/sdk/)
Install as a **dev dependency** in your plugin project. The package ships type declarations, HTTP/storage/UI helpers, and a JSX runtime that forwards to the host's React instance via `installReact(hc.react)`.
Requires HarborClient **>=1.9.0** when using `hc.pluginId`, renderer HTTP lifecycle events, typed IPC invoke, and host request commands.
## Install
```bash
pnpm add -D @harborclient/sdk
```
See the [install guide](https://harborclient.github.io/sdk/install) for version requirements.
## Quick start
```tsx
import { installReact } from '@harborclient/sdk';
import type { PluginContext } from '@harborclient/sdk';
export function activate(hc: PluginContext): void {
installReact(hc.react);
// register contributions…
}
```
Full guides — package layout, manifest, APIs, examples, and dev workflow — live in the [plugin development docs](https://harborclient.github.io/sdk/).
## Trusted publishers
HarborClient maintains a [trusted publisher registry](https://harborclient.com/plugins/trusted.json). Authors listed there must sign every plugin they publish; HarborClient rejects installs that claim a trusted author name without a valid signature. See the [signing guide](https://harborclient.github.io/sdk/signing) for key generation and verification.
To discuss becoming a trusted publisher, email [contact@harborclient.com](mailto:contact@harborclient.com).
## License
MIT