syncanix init

init is the command you’ll run most. It scans your project, turns your API into a capability catalog, and uploads it to your workspace.

npx syncanix init

Options

-f, --framework <name>

Force a framework instead of auto-detecting (nestjs, express, fastapi, nextjs, graphql).

--offline

Write the catalog locally without uploading it.

-y, --yes

Accept defaults and skip prompts (assumes managed-enrichment consent).

What it does

1. 1
   Detects your frameworksScans the project and reports every framework it recognises — not just the top one.
2. 2
   Extracts capabilitiesReads your routes and builds a structured list of capabilities, with their inputs and side effects.
3. 3
   Applies .syncanixignoreDrops anything matching your ignore rules before it’s written, enriched, or uploaded.
4. 4
   Asks about AI enrichmentShows a cost estimate and asks how you’d like to proceed before any code text is sent to a provider.
5. 5
   Writes the catalogSaves a deterministic .syncanix/catalog.json you can review and commit.
6. 6
   Uploads itSends the catalog to your workspace, unless you passed --offline or have no API key yet.

Static by default

Discovery reads your code; it never runs it, and no production data leaves your machine. The only thing that can be sent is the structured catalog — and AI enrichment only happens with your explicit consent.

Consent for AI enrichment

AI enrichment writes clearer titles and descriptions for your capabilities. Before sending anything, the CLI shows exactly what would be sent (capability ids, methods and paths, argument names, and a short, secrets-redacted handler excerpt) and what would not (source files, your data, secrets, anything ignored). You then choose a mode:

Managed

Use Syncanix’s provider key under a zero-data-retention contract.

BYOK

Use your own provider key; handler text goes straight from your machine to the provider, and Syncanix never sees it.

Skip

No enrichment — ship extractor-only metadata and enrich later from the dashboard.

Next steps