open-matrix/hivecast-sdk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
hivecast-sdk/examples/hivecast-login/README.md

1.2 KiB
Raw Blame History

HiveCast API-Key Login Demo

This demo proves the SDK-side HiveCast credential shape without committing a secret.

It validates a user-supplied HiveCast API key against the configured HiveCast cloud, then writes the same package-local .matrix config/credential files that matrix configure writes. This is the current API-key login shape.

It does not prove hosted broker execution yet. The SDK still needs a provider-owned credential exchange/login command before a package can use a HiveCast-issued broker JWT directly from this repo.

Run

export MATRIX_CLOUD=https://dev.hivecast.ai
export MATRIX_SPACE=<your-space-root>
export MATRIX_API_KEY=<your-api-key>

pnpm demo:hivecast-login

Optional:

MATRIX_DEMO_HOME=/tmp/my-sdk-hivecast-demo pnpm demo:hivecast-login
MATRIX_DEMO_KEEP=1 pnpm demo:hivecast-login

The key is never printed. By default the temporary demo home is deleted after a successful run. Set MATRIX_DEMO_KEEP=1 to inspect the generated .matrix files locally.

Check Script Wiring Without A Key

pnpm demo:hivecast-login -- --check

This only verifies that the demo is installed and intentionally refuses to run without credentials.