Configuration files
The files the CLI reads and writes: ignore rules, CLI config, the catalog, your consent record, credentials, and the catalog overlay.
The CLI uses a small set of files in your repository and home directory. Here is what each one is for.
- .syncanixignore
- A gitignore-style file at your repo root. Anything it matches is never scanned, enriched, or uploaded. It layers on top of a built-in default list and your .gitignore.
- .syncanix.yaml
- CLI configuration at your repo root: include/exclude globs, per-capability overrides, the enrichment mode and cost cap, and scope renames.
- .syncanix/catalog.json
- The deterministic catalog that discovery produces. Review it and commit it like any other source file.
- .syncanix/consent.json
- Your AI-enrichment consent record. Safe to commit — it records your choice (managed, BYOK, or skip) and holds no secrets.
- ~/.syncanix/credentials
- Your secret API key, stored in your home directory and readable only by you. Created by syncanix login and removed by syncanix logout.
- syncanix.yaml
- An optional, committed catalog-as-code overlay (overrides, additions, and policies) that yaml apply merges onto a discovered catalog. The leading dot distinguishes the CLI config .syncanix.yaml from this overlay, syncanix.yaml.