Skip to content

Project · developer-library

Web SDK

a toolkit for hosted app interfacesStandard development kit for creating Web UIs that work with Holo Hosting.
How you run it
not recorded
Holochain version
not recorded
Activity
stalled
Checked
27 October 2026

What is Web SDK and what is it for?

Web SDK is a JavaScript toolkit that let a Holochain app's own web page talk to that app while it runs on a hosting computer, a HoloPort, rather than on the visitor's own machine. It exists because a hosted app's web interface needs more than a plain Holochain connection: it has to work out which hosted identity it is acting as, sign that person in through a protected login window, and then make the app's own calls on their behalf.

Web SDK was the piece Holo Hosting provided for the visible half of a hosted Holochain app. An app running on a HoloPort needs a web interface people can open in a browser, and that interface has to reach the app across the network rather than through a connection on the visitor's own computer. Web SDK packaged that connection as a JavaScript library for building such interfaces; the project's own documentation labels it a prerelease.

The library covers the parts a hosted app's web page cannot do alone. It inserts a small frame into the page that stays hidden until the visitor signs in or signs up, when the frame takes over the screen with a credentials form. Because that form lives in its own frame, the app's web page never sees the visitor's private keys or password. The library also reports which hosted identity is in use and exposes the app's own functions to the page.

A worked example in the repository shows the whole path: open a connection, wait until the client reports the hosted identity is available, ask the visitor to sign in, then call a function on the app and print the result. The project also points to a companion demonstration interface, dummy-ui, in the Chaperone repository, and to a local development server for testing before publishing an app to Holo Hosting. Start with the repository README.

How to get it

As a library

  1. Install the JavaScript package recorded by the project as @holo-host/web-sdk.
  2. Import it into the web interface you are building: import WebSdk from '@holo-host/web-sdk'.
  3. Open a connection with WebSdk.connect({ chaperoneUrl }) — a local holo-dev-server Chaperone while developing, or the Chaperone URL configured for Holo Hosting.
  4. Wait until the reported identity is available, or listen for the agent-state event, before calling functions on the app.

Source: https://www.npmjs.com/package/@holo-host/web-sdk

Questions people ask

Does Web SDK replace holochain-client-js?
No. It provides the same methods for working with a Holochain agent as AppWebsocket from holochain-client-js, and adds methods for determining which hosted identity to use. source
How does a web interface handle sign-in?
The SDK inserts a frame that is hidden until sign-in or sign-up is requested, then covers the screen with a credentials form, so the app's web page cannot directly reach the visitor's private keys or passwords. source
How do you try it while still developing an app?
The production Chaperone connects to real HoloPorts and expects a published app, so the documentation describes a local Chaperone through holo-dev-server that directs everyone to a locally simulated HoloPort. source

From 4 public sources, checked 23 September 2026.

Try Web SDK

Details & sources

Evidence

Release
github.com/Holo-Host/web-sdk/releases/tag/v0.6.14-prereleaseshipped in a release · seen since 20 October 2026 · github.release@1
Last change
api.github.com/repos/Holo-Host/web-sdklisted by a third party · seen since 20 October 2026 · github.repository@1
Activity
api.github.com/repos/Holo-Host/web-sdklisted by a third party · seen since 20 October 2026 · liveness@1

Compatibility

hdk
—
hdi
—
holochain-client
0.18.0-dev.2 · package.json @ f84e0da
happ.yaml
absent
web-happ.yaml
absent
Do you maintain Web SDK?Add your name to this project’s page.
Claim this page