Quickstart

Install andy-partner and take one Agent from sign-in to a verified Widget answer.

Outcome

Create and configure an Agent, activate reviewed Knowledge, allow one exact Widget origin, and verify a real public answer.

Prerequisites

Node 20 or newer.
A supported Andy User. Complete first-time account setup in the Andy App before using the CLI.
A public HTTPS origin where the Widget will run.
A UTF-8 product.md file containing visitor-safe facts.

bun add --global andy-partner@0.1.2
andy version --json
andy auth login
andy auth status --json

The login command opens Clerk’s browser-assisted OAuth Authorization Code flow with S256 PKCE. Andy does not implement a second password, email-code, or MFA system in the CLI.

2. Create, select, and configure the tenant

andy workspace create --name "Example Workspace" --json
andy workspace list --json
andy workspace select --workspace <workspace-id-or-slug>
andy agent create --workspace <workspace-id> --name "Website Assistant" --language en --json
andy agent configure --workspace <workspace-id> --agent <agent-id> --instructions "Answer only from reviewed Knowledge." --json
andy agent inspect --workspace <workspace-id> --agent <agent-id> --json

Keep the returned Workspace and Agent IDs. Mutations are idempotent and every response includes a request ID.

3. Add reviewed Knowledge

Prepare its SHA-256 digest, then add and await the active source:

digest="sha256:$(shasum -a 256 product.md | cut -d ' ' -f 1)"
andy knowledge-source add --workspace <workspace-id> --agent <agent-id> --key product --title "Product" --provenance-kind repository --provenance-uri docs/product.md --revision git:<commit> --digest "$digest" --file ./product.md --json
andy knowledge-source wait --workspace <workspace-id> --agent <agent-id> --source <source-id> --timeout-ms 120000 --json

Create the Widget JSON explicitly, then apply it and the exact allowed origin:

cat > widget.json <<'JSON'
{
  "allowedOrigins": ["https://example.com"],
  "position": "bottom-right",
  "primaryColor": "#6d28d9",
  "welcomeMessage": "How can I help?"
}
JSON
andy public-chat enable --workspace <workspace-id> --agent <agent-id> --website https://example.com --json
andy widget configure --workspace <workspace-id> --agent <agent-id> --config ./widget.json --json
andy widget manifest --workspace <workspace-id> --agent <agent-id> --json

Machine-readable verification

andy auth status --json
andy agent inspect --workspace <workspace-id> --agent <agent-id> --json
andy knowledge-source inspect --workspace <workspace-id> --agent <agent-id> --source <source-id> --json
andy widget manifest --workspace <workspace-id> --agent <agent-id> --json
andy widget verify --workspace <workspace-id> --agent <agent-id> --origin https://example.com --json

widget verify checks Agent identity, effective settings, the exact allowed origin, Knowledge readiness, Public Chat state, and one real answer. It consumes one conversation and quota unit.

Next step

Continue with Authentication, Knowledge reconciliation, or the Widget package.