h5adexp
v0.1.17
Published
Single-file H5AD exploration service and LAN-friendly CLI
Maintainers
Readme
h5adexp
h5adexp is a single-file H5AD explorer. It starts a local Node.js service for one .h5ad file and serves the seqyuan React exploration UI, which can be opened directly on the LAN or embedded by another LAN web tool.
Quick LAN Explore
npm install -g h5adexp
h5adexp serve --file /path/to/sample.h5adThe npm package and CLI command remain h5adexp; the browser UI brand shown in the top-left navbar is seqyuan.
By default the server listens on 0.0.0.0:3001. The CLI prints JSON containing:
url: a direct browser URL using this machine's LAN IP when available.localUrl: a same-machine URL.embedUrl: the compatibility URL with explicit token/query parameters.
Open url from another device on the same LAN. Opening http://<machine-ip>:3001/ also works because the app auto-loads the registered single file from /api/embed/config.
Options
h5adexp serve --file sample.h5ad --port 42317
h5adexp serve --file sample.h5ad --host 127.0.0.1
h5adexp serve --file sample.h5ad --host 0.0.0.0 --origin http://localhost:30141--file <path>: required H5AD file.--host <host>: default0.0.0.0for LAN access; use127.0.0.1for local-only access.--port <port>: default3001.--runtime-home <dir>: runtime config/cache directory; defaults to a temporary isolated directory.--origin <url>: iframe parent origin for integrations such as AnnoVibe.--embed: accepted for compatibility; single-file mode enables embed config automatically.
h5adexp serve without --file is intentionally disabled. The product mode is one registered H5AD file per server process. Internal API and worker names may still contain projecthub because they are the stable remote compute layer, not a user-facing ProjectHub mode.
Build And Publish
npm install
npm run build:ci
npm run release:check
npm publish --access publicbuild/ and dist/ are generated artifacts. They are ignored by git but included in the npm package through package.json#files.
GitHub npm Release
The repository publishes to npm from tags named v<package.version>.
Required GitHub setup:
- Environment:
npm-publish - Repository secret:
NPM_TOKEN, created from the npm accountseqyuan
Release flow:
npm version patch --no-git-tag-version
npm run build:ci
npm run release:check
git add package.json package-lock.json README.md
VERSION=$(node -p "require('./package.json').version")
git commit -m "Release v${VERSION}"
git tag -a "v${VERSION}" -m "Release v${VERSION}" -m "Changes:" -m "- Summarize the release changes."
git push origin main --tagsUse an annotated tag and include the release notes in the tag message. The tag workflow verifies that the tag matches package.json#version, the tag commit is on main, and npm whoami for NPM_TOKEN is seqyuan.
