HypercubsDRC Docs
how-to developer public

Install DRC

Install an application SDK through npm, or install the CLI through npm, then initialize a local workspace.

Prerequisites

  • macOS or Linux
  • Windows: experimental. The CLI runs on Windows for evaluation, but Windows support is not production-ready yet.
  • An application with a development port you can proxy

For hosted use, also prepare an API URL and an authentication token. Do not put tokens in shell history, source files, issue descriptions, or support bundles.

Install an application SDK

Install only the package your application needs:


npm install @drc/sdk
npm install @drc/express     # Express middleware, when applicable
npm install @drc/browser     # browser capture, when applicable

Install the CLI

The CLI is published to the public npm registry:


npm install -g @drc/cli

npm places the drc binary on your PATH. Verify the install with drc --version. The npm package is the only supported installation source; do not build the CLI from a source repository.

Initialize local storage


drc init

Initialization creates the local workspace and reports the selected storage path. Local capture requires a managed signing key; do not use an ephemeral key for a durable workspace.

Verify the installation


drc doctor
drc search --format table

drc doctor reports configuration problems without claiming that a hosted control plane is healthy. A command that cannot complete returns a non-zero exit status.

Connect a hosted workspace


drc login --api-url https://api.drc.sh --email [email protected]
drc config get

Use the hosted API URL supplied by your organization for private or self-managed deployments. Hosted requests require a tenant-scoped token.

Troubleshoot

  • Command not found: ensure the installation directory is on PATH.
  • Signing-key error: configure the managed local signing-key path and make the file readable only by the DRC process.
  • API authentication error: verify the API URL, token expiry, tenant membership, and local clock.
  • No executions: capture traffic through the DRC proxy before searching.

Next, follow Capture and replay an execution.