Quickstart

Install on Linux

The installer supports Linux on x86-64 and arm64. It downloads a self-contained runtime and starts it with systemd when available.

curl -fsSL https://www.codevisor.dev/install.sh | sh

The default port is 49361. A non-root install uses ~/.codevisor; a root install uses /opt/codevisor for the runtime and /var/lib/codevisor for data. In an interactive terminal, the installer runs setup after installation. Rerun it at any time:

codevisor setup

Setup starts the server, asks how clients should reach it, and prints a stable connection token, deeplink, and QR code. Tailscale is the recommended remote path.

Check health locally

curl http://127.0.0.1:49361/v1/health

Health reports whether the database is ready. GET /v1/discovery is also tokenless and returns a minimal machine manifest for private-network discovery.

Authenticate a client

For a client you control, read the machine's stable connection token locally:

TOKEN=$(codevisor token)

Treat the returned hm_… value as a password. Remote requests send it as a bearer token:

curl http://SERVER_ADDRESS:49361/v1/info \
  -H "Authorization: Bearer $TOKEN"

You can also enter the machine address and token in Codevisor under Machines → Add Machine.

To create a separate credential instead, call POST /v1/auth/pairing-token from localhost. The server stores only its hash and does not expose that token again.

Inspect the contract

curl http://SERVER_ADDRESS:49361/v1/openapi.json \
  -H "Authorization: Bearer $TOKEN" > codevisor-openapi.json

Use API concepts before implementing replaying event or terminal sockets.