installation

Installation

Install the Klock OSS v1 SDKs and local server workflow.

Klock OSS v1 is intentionally narrow:

  • Python SDK
  • JavaScript SDK
  • LangChain integration
  • one local coordination server

Python

pip install klock

For the canonical integration path:

pip install klock-langchain

JavaScript / TypeScript

npm install @klock-protocol/core

This package now exposes both KlockClient and KlockHttpClient.

Local Klock server

The local repo/workspace workflow still uses klock-cli, but KlockHttpClient("http://localhost:3100") now auto-starts it by default when it can find a launch command.

Launch order:

  1. KLOCK_SERVER_COMMAND
  2. installed klock binary
  3. source-tree cargo run --release -p klock-cli -- serve

By default the server listens on http://localhost:3100.

When auto-start happens, the SDK logs the base URL, launch command, and PID.

Disable auto-start with KLOCK_DISABLE_AUTOSTART=1, autoStart: false, or auto_start=False.

Optional server configuration

| Flag | Default | Description | |------|---------|-------------| | --port | 3100 | HTTP port | | --host | 0.0.0.0 | Bind address | | --storage | memory | memory or sqlite:<path> |

Recommended first run

After installation, go straight to the Quick Start and run:

python3 without_klock.py
python3 with_klock.py
python3 wait_die_trace.py