Docs · 4 steps to first identity

Get started with Vigil.

Vigil ships as a single Go binary. The four steps below mint an agent identity through the proxy’s HTTP API. State persists under ~/.vigil/.

Quickstart
  1. 01

    Run the proxy

    Install the binary and start the proxy. Listens on :7432 for Postgres clients (configurable) and :7878 for the identity HTTP API. State persists under ~/.vigil/.

    brew install constantinexanthos/vigil/vigil
    vigil-proxy --postgres-listen :7432 --postgres-upstream localhost:5432
  2. 02

    Issue an identity

    Mint a stable ID for an agent. Vigil signs it with an Ed25519 key generated on first start.

    curl -X POST http://localhost:7878/identities \
      -H 'content-type: application/json' \
      -d '{"agent_name":"claude-code","principal":"costa@example.com","scopes":["read","write"]}'
  3. 03

    Fetch an identity

    Retrieve a previously issued identity by its UUID to verify scopes or replay an audit query.

    curl http://localhost:7878/identities/{id}
  4. 04

    List identities

    List every identity Vigil has issued. Useful for quick visibility into who's hitting your data path.

    curl http://localhost:7878/identities
What's next

Full docs are coming. For now, the code is the source of truth.

The proxy lives in the proxy/ directory of the main repo. Implementation, tests, and the design spec are all there. Open an issue, or read the design doc directly in the repo.