Hay documentation
Build a plugin, keep your work local, and share it when it is ready.
Hay is a desktop workspace with chat, a built-in browser, native coding tools, and optional plugins. A Hay account is required to use the app; one account connection is shared by the workspaces on your Mac. A plugin adds a focused interface. Hay provides the model connection, local records, and reviewed access to capabilities.
Find your starting point
- Sign in or create an account: verify your email, optionally choose a public handle and approve app sign-in.
- Find and install plugins: browse public releases and review installation in Hay.
- Build your first plugin: make a small tool with local storage.
- Understand local plugins: find saved code, export source, and share a plugin file.
- Use the SDK: read data, generate outputs, hand off work, and use host tools.
- Publish to Hay: release a code-only copy under your personal publisher identity.
- Keep private releases: publish code for your account only.
- Host a registry: prepare immutable releases for a custom catalog.
A plugin has three places
| Place | What belongs there |
|---|---|
| Source project | The editable manifest and self-contained HTML you keep in a folder or Git repository. |
| Installed copy | The code Hay saves inside one workspace, with that workspace’s records and permissions. |
| Shared release | A versioned plugin bundle or registry artifact that other people can install. |
Editing a source folder does not silently update the installed copy. Sharing a plugin does not share its workspace records.
What is available
Local creation, imports, exports, custom registries, capability review, browser tools, and native coding are implemented in the desktop app. The package and registry formats are version 1; the SDK reference is version 0.1.
The account and direct-publishing implementation uses email-code sign-in, personal publisher ownership and immutable releases. New clients use the account/API origin https://app.hay.so; the registry stays at https://plugins.hay.so. Existing live inbox-code, publication, history and revocation checks used the legacy account host and shared D1 database. Read account migration for preserved logins and the operator record for new-origin rollout evidence. The first public release is Documents 0.1.1 (halil.documents); install it with empty records and reviewed permissions. The marketplace guide explains web discovery and exact install links. The operator record tracks marketplace and personal-registry rollout separately from the earlier live catalog checks. Custom static registries remain supported.
For agents
Start with the agent guide, SDK reference, and registry contract. Every page has a plain Markdown version. llms.txt indexes the docs; llms-full.txt contains them in one text file.