on main help sign in
docs(readme): add initialize_as (#1438)
882914dAmolith
README.md+22
@@ -335,6 +335,28 @@ permissions. Use this with care.
335You can also skip all permission prompts entirely by running Crush with the
335You can also skip all permission prompts entirely by running Crush with the
336`--yolo` flag. Be very, very careful with this feature.
336`--yolo` flag. Be very, very careful with this feature.
337
337
338+### Initialization
339+
340+When you initialize a project, Crush analyzes your codebase and creates
341+a context file that helps it work more effectively in future sessions.
342+By default, this file is named `AGENTS.md`, but you can customize the
343+name and location with the `initialize_as` option:
344+
345+```json
346+{
347+ "$schema": "https://charm.land/crush.json",
348+ "options": {
349+ "initialize_as": "AGENTS.md"
350+ }
351+}
352+```
353+
354+This is useful if you prefer a different naming convention or want to
355+place the file in a specific directory (e.g., `CRUSH.md` or
356+`docs/LLMs.md`). Crush will fill the file with project-specific context
357+like build commands, code patterns, and conventions it discovered during
358+initialization.
359+
338### Attribution Settings
360### Attribution Settings
339
361
340By default, Crush adds attribution information to Git commits and pull requests
362By default, Crush adds attribution information to Git commits and pull requests