Skip to main content
This path connects an existing JavaScript or TypeScript agent on Node.js 18+. For another runtime, use Python, MCP, or Codex.
1

Install and sign in

From the repository containing your agent:
A Workspace Admin authorizes the CLI in the browser. connect creates or links the agent, writes its connection string to the repository’s git-ignored .env, and gives you a setup prompt. Check that you are in the intended workspace with rippletide workspaces current.
2

Apply the generated prompt

Paste the prompt into the coding agent you use for that repository. It adds the SDK at your existing model, tool, and response-delivery boundaries. The CLI does not launch the coding agent or start your application.For a session without an interactive terminal, sign in first and request the prompt explicitly:
Keep --kind agent on the first connection: the CLI does not guess whether the repository contains an agent or an MCP server. The prompt contains no Connection key. Keep the generated .env git-ignored.
3

Run a real turn

Start the application normally, with its own provider and tool credentials. Send a request that uses a tool and delivers a response to its normal recipient.Before using customer data, choose the appropriate capture mode. The TypeScript SDK captures bounded content in full mode by default; metadata and redacted are available.
4

Verify the complete connection

verify checks local configuration and declared inventory. events --wait checks the server’s evidence contract. For an SDK agent this includes inventory, heartbeat, a tool call when required, a turn, and a proven before-response delivery boundary.In the app, inspect Context & actions for instructions, actions, and connections. Open Traces for the run, tool calls, policy decisions, and delivery outcome. A model response is a candidate until the delivery callback runs.If before_response is missing, check that deliverResponse() stays inside the causal run() and wraps the actual delivery callback. See Manual TypeScript setup.
5

Observe your first Rule

  1. Open Rules and describe a restriction on the tool you just used.
  2. Review its action scope and setup, then save and set its release to Observe.
  3. Repeat the tool-using request in a safe test environment.
  4. Inspect the recorded match and Would block disposition. The action still runs in Observe.
  5. Follow Test your rules before an Admin enables Enforce.

​
If evidence is missing

Run rippletide doctor. Check the repository binding, .env location, current workspace, and whether the instrumented process is running. Provider credentials are still your application’s responsibility. Share diagnostic messages with your Rippletide contact, never the key or the .env itself.