CLI

confiqure init

Generate or update confiqure.config.json in the current directory. This file tells the CLI which paths to scan for annotated classes.

Synopsis

$ confiqure init [-y, --yes]

Flags

What gets written

{
  "scanPaths": ["src/**", "lib/**", "app/**"],
  "guides": ["docs/user-guides"],
  "ignore": [
    "node_modules", ".git", "target", "build", "dist",
    ".nuxt", ".output", ".venv", "__pycache__", "bin", "obj"
  ],
  "languages": {
    "java":       { "extensions": [".java"],  "tokenPattern": "@Confiqure" },
    "kotlin":     { "extensions": [".kt"],    "tokenPattern": "@Confiqure" },
    "scala":      { "extensions": [".scala"], "tokenPattern": "@Confiqure" },
    "python":     { "extensions": [".py"],    "tokenPattern": "@Confiqure" },
    "typescript": { "extensions": [".ts", ".tsx", ".js", ".jsx"], "tokenPattern": "@Confiqure" },
    "csharp":     { "extensions": [".cs"],    "tokenPattern": "[Confiqure" },
    "rust":       { "extensions": [".rs"],    "tokenPattern": "#[confiqure" },
    "php":        { "extensions": [".php"],   "tokenPattern": "#[Confiqure" },
    "swift":      { "extensions": [".swift"], "tokenPattern": "Confiqurable" }
  }
}

The languages map drives the scanner — file extensions plus the token pattern that marks an annotated file. If your codebase uses a custom import alias, change the pattern here.

guides — your user documentation

guides marks the folders holding your product's own user guides. Every full confiqure push hashes what's in those folders, uploads only what changed, and retires pages you deleted in git. Git stays the version control — the CLI mirrors it, so there's no separate authoring screen and nothing to keep in sync by hand.

The chat then searches your guides and answers "how do I…" questions from them, citing the page — instead of improvising an answer or asking the user for something your documentation already explains.

• Synced file types: .md .markdown .txt .html .pdf, plus .png / .jpg / .gif / .webp / .svg screenshots. Anything else in the folder is ignored; the per-file limit is 10 MB.
• Guides land in your sandbox like any push, and are mirrored to production by --production / --live.
• Set "guides": [] to turn the sync off.

When to re-run

• You move source code into new top-level directories that aren't covered by scanPaths.
• You add a new build artifact directory that should be ignored.
• You start (or move) a user-guides folder that the chat should be able to answer from.