CLI

Use arcy init to set up ARCY automatically. Fastest path to a working integration.

arcy init scans your codebase, wires up ARCYProvider, adds data-arcy attributes to key UI elements, and generates the .arcy/ Application Knowledge Graph: the structured YAML files ARCY uses to understand your product.

Step 1: Add your keys to .env

Get your keys from the ARCY dashboard under Apps > [your app] > Keys.

Add to .env.local:

bash

NEXT_PUBLIC_ARCY_PUBLISHABLE_KEY=pk_live_...
ARCY_SECRET_KEY=sk_live_...

Add to .env:

bash

VITE_ARCY_PUBLISHABLE_KEY=pk_live_...
ARCY_SECRET_KEY=sk_live_...

Both keys are required. The CLI reads them from your env file automatically.

Step 2: Install and run

bash

npm install -g @arcyai/sdk
arcy init

bash

pnpm add -g @arcyai/sdk
arcy init

bash

bun add -g @arcyai/sdk
arcy init

bash

yarn global add @arcyai/sdk
arcy init

The CLI detects your framework, scans your source files, and shows you a consent prompt before sending anything. After you confirm, it applies changes and generates your .arcy/ knowledge graph. Then push your configuration:

bash

arcy push

Step 3: Verify

Start your dev server. A floating widget should appear in the bottom-center. Clicking it opens the ARCY.

If the button does not appear, check your browser console for errors. The most common cause is a missing or incorrect public key.

What to expect during init

Framework detection

The CLI first detects your project setup:

  Detecting project
  ✓ Framework:  Next.js (App Router)
  ✓ Auth:       @clerk/nextjs
  ✓ Entry:      src/app/layout.tsx
  ✓ TypeScript: true

File scan

The CLI scans up to 30 of your source files (layouts, pages, components) and lists what it found:

  Scanning files
  ✓ Detected 24 relevant files
    src/app/layout.tsx
    src/app/page.tsx
    src/components/sidebar.tsx
    src/components/header.tsx
    ... and 20 more

Before sending anything, the CLI shows every file it will transmit to AWS Bedrock along with the size, then asks for confirmation:

  Privacy
  arcy init reads your source files and sends them to AWS Bedrock to generate your .arcy/ knowledge graph and wire up the SDK.

    src/app/layout.tsx                    2.1 KB
    src/app/page.tsx                      1.4 KB
    src/components/sidebar.tsx            3.8 KB
    ... and 21 more  (arcy init --scan-preview for the full list)

  24 files · 58.3 KB total
  Config files (.env, *.pem, *.key) are always excluded.

  AWS Bedrock does not train on customer data.
  Data processing agreement: aws.amazon.com/service-terms (section 50)
  ARCY does not store your file contents after analysis completes.

  ? Send files for analysis? (y/N)

Type y to proceed. Type n to abort. Nothing is sent and no files are changed.

To preview the exact file list without running init:

bash

arcy init --scan-preview

Monorepo prompt

If the CLI detects a monorepo (pnpm-workspace.yaml), it asks which app to set up:

  Multiple apps found. Which app are you setting up?
    1. apps/dashboard
    2. apps/landing
    3. Other (enter path manually)

  ? Select (1-3):

What's next

CLI commands: use arcy sync, arcy push, and arcy status as your integration grows
Configuration: all ARCYProvider props
AI modes: how Chat, Teach, and Agent modes work

On this page