|
@@ -421,23 +421,25 @@ cg.close();
|
|
|
|
|
|
|
|
## Configuration
|
|
## Configuration
|
|
|
|
|
|
|
|
-There isn't any — CodeGraph is zero-config. It indexes every file whose
|
|
|
|
|
-extension maps to a [supported language](#supported-languages) and **respects
|
|
|
|
|
-your `.gitignore`**: in git repos via git itself, and in non-git projects by
|
|
|
|
|
-reading `.gitignore` files directly (root and nested, the same way git would).
|
|
|
|
|
-
|
|
|
|
|
-What that means in practice:
|
|
|
|
|
-
|
|
|
|
|
-- Anything git ignores — `node_modules`, build output, secrets in `.env` — is
|
|
|
|
|
- never indexed. **To keep something out of the graph, add it to `.gitignore`.**
|
|
|
|
|
-- There's no config file to write or keep in sync, and nothing to wire up per
|
|
|
|
|
- language: support is automatic from the file extension.
|
|
|
|
|
-- Files larger than 1 MB are skipped (generated bundles, minified JS, vendored
|
|
|
|
|
- blobs) — they cost parse budget for no useful symbols.
|
|
|
|
|
-
|
|
|
|
|
-> Committed files that aren't gitignored *are* indexed, even under `vendor/` or a
|
|
|
|
|
-> committed `dist/`. If you commit a dependency or build directory you don't want
|
|
|
|
|
-> in the graph, add it to `.gitignore`.
|
|
|
|
|
|
|
+There isn't any — CodeGraph is zero-config, with **no config file** to write or
|
|
|
|
|
+keep in sync. Language support is automatic from the file extension; there's
|
|
|
|
|
+nothing to wire up per language.
|
|
|
|
|
+
|
|
|
|
|
+What it skips out of the box:
|
|
|
|
|
+
|
|
|
|
|
+- **Dependency, build, and cache directories** — `node_modules`, `vendor`,
|
|
|
|
|
+ `dist`, `build`, `target`, `.venv`, `Pods`, `.next`, and the like across every
|
|
|
|
|
+ [supported stack](#supported-languages) — so the graph is your code, not
|
|
|
|
|
+ third-party noise. This holds even with no `.gitignore`.
|
|
|
|
|
+- **Anything in your `.gitignore`** — honored in git repos via git, and in
|
|
|
|
|
+ non-git projects by reading `.gitignore` directly (root and nested).
|
|
|
|
|
+- **Files larger than 1 MB** — generated bundles, minified JS, vendored blobs.
|
|
|
|
|
+
|
|
|
|
|
+To keep something else out, add it to `.gitignore`. To pull a default-excluded
|
|
|
|
|
+directory back **in** (say you really do want a vendored dependency indexed),
|
|
|
|
|
+add a negation — `!vendor/`. The defaults apply uniformly, so committing a
|
|
|
|
|
+dependency or build directory doesn't force it into the graph; the `.gitignore`
|
|
|
|
|
+negation is the explicit opt-in.
|
|
|
|
|
|
|
|
## Supported Platforms
|
|
## Supported Platforms
|
|
|
|
|
|
|
@@ -502,7 +504,7 @@ the MCP server and writing its instructions file:
|
|
|
|
|
|
|
|
**MCP server not connecting** — Ensure the project is initialized/indexed, verify the path in your MCP config, and check that `codegraph serve --mcp` works from the command line.
|
|
**MCP server not connecting** — Ensure the project is initialized/indexed, verify the path in your MCP config, and check that `codegraph serve --mcp` works from the command line.
|
|
|
|
|
|
|
|
-**Missing symbols** — The MCP server auto-syncs on save (wait a couple seconds). Run `codegraph sync` manually if needed. Check that the file's language is supported and isn't excluded by config patterns.
|
|
|
|
|
|
|
+**Missing symbols** — The MCP server auto-syncs on save (wait a couple seconds). Run `codegraph sync` manually if needed. Check that the file's language is supported and isn't inside a `.gitignore`d or default-excluded directory (e.g. `node_modules`, `dist`).
|
|
|
|
|
|
|
|
## Star History
|
|
## Star History
|
|
|
|
|
|