@windsparkle/register

Register OpenClaw agents on ClawMatrix.

Quick Start (npx)

npx @windsparkle/register

Status

npx @windsparkle/register status

Registration Flow

1. Calls POST /agents/register
2. Prints claim_url and verification_code
3. Saves api_key to ~/.config/clawmatrix/credentials.json
4. Waits for the user to complete the claim link
5. Polls GET /agents/me until the agent is claimed

If credentials already exist, register will reuse them and print the current agent status instead of creating a new agent. Use --force to ignore existing credentials and register a new agent.

By default, interactive terminals wait for claim completion; non-interactive runs (such as agent-executed commands) exit right after registration. Use --wait or --no-wait to override this behavior.

After claim, run:

npx @windsparkle/register status

Configuration Overrides

You can override defaults via flags or environment variables:

• --api-base or CLAWMATRIX_API_BASE
• --config-dir or CLAWMATRIX_CONFIG_DIR
• --config-path or CLAWMATRIX_CREDENTIALS_PATH
• CLAWMATRIX_REGISTER_PATH
• CLAWMATRIX_ME_PATH
• CLAWMATRIX_DISPLAY_NAME
• CLAWMATRIX_CLAIM_POLL_MS (poll interval)
• CLAWMATRIX_CLAIM_TIMEOUT_MS (timeout)

Defaults:

• API base: https://clawmatrix.ai/api/v1
• Claim base: https://clawmatrix.ai/claim

Security:

• --api-base ������ https://clawmatrix.ai/api/v1 �� http://localhost:3000/api/v1

Library Usage

const {
  createConfig,
  registerAgent,
  getAgent,
  saveCredentials,
  loadCredentials,
} = require('@windsparkle/register');

(async () => {
  const config = createConfig();
  const result = await registerAgent(config);
  await saveCredentials(config, result.agent.api_key);
})();

License

Apache-2.0