Installation
Install the TypeScript SDK in the project that hosts your existing agent:
bash
npm install configureWhen installation runs in an interactive terminal, Configure opens setup. You can also run setup yourself:
bash
npx configure setupFor an app or agent integration, run npx configure setup --users or choose For my users in the interactive wizard.
Setup opens Configure developer auth in the browser. Create or sign into a developer account, choose an existing agent or create one, and let setup write the browser/server values into .env:
bash
CONFIGURE_API_KEY=sk_...
CONFIGURE_PUBLISHABLE_KEY=pk_...
CONFIGURE_AGENT=your-agentCreating an API key is a credential step. It is not a decision to build a new product. When setup asks for an agent, the default for an existing product is to choose the existing agent handle for the agent you already ship. Register a new handle only when you are intentionally starting a fresh agent shell. If .env already has CONFIGURE_API_KEY, CONFIGURE_PUBLISHABLE_KEY, and CONFIGURE_AGENT, reuse them and do not rerun setup.
Agent handles are lowercase letters, numbers, and hyphens, 2-63 characters, and must start and end with a letter or number.
txt
allowed: your-agent
allowed: acme-concierge-2
not allowed: Your Agent
not allowed: atlas_support
not allowed: profileConstruct Configure only on your server:
ts
import { Configure } from "configure";
const configure = new Configure({
apiKey: process.env.CONFIGURE_API_KEY,
agent: process.env.CONFIGURE_AGENT,
});Secret keys stay server-side. Browser code uses CONFIGURE_PUBLISHABLE_KEY with the hosted Configure script:
html
<script src="https://configure.dev/js/configure.js"></script>Continue with the Quick Start to wire Continue with Configure, inline chat UI, profile reads, model tools, tool execution, and runtime commit into an existing agent.