on main help sign in
docs(readme): add initialize_as (#1438)
commit882914dcae7b52302c59c10880a5f66dc0d2923e authorAmolith <amolith@secluded.site> dateThu 13 Nov 2025, 12:23 (1 year ago) parentee47e3d
1 file changed+22
README.md+22
README.md+22
@@ -335,6 +335,28 @@ permissions. Use this with care.
335335You can also skip all permission prompts entirely by running Crush with the
336336`--yolo` flag. Be very, very careful with this feature.
337337
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+
338360### Attribution Settings
339361
340362By default, Crush adds attribution information to Git commits and pull requests