Update the README or create a Wiki

[jialanhu0915]

Description

Dear developers, I really like Crush, but I have encountered many issues during the setup process. I can hardly find any relevant tutorials online, so I hope you could enrich the README or provide a wiki.

[meowgorithm]

Appreciate the feedback and we’re noting this down!

I’d love to know:

• Which issues have you encountered during setup? (If possible, we can help you work through them here.)
• What would you like to see in terms of documentation and tutorials?

[jialanhu0915]

I'm quite curious about what specific settings in Crush can be configured. Sometimes when something goes wrong, I want to debug and check detailed information, but I don't know how to do it.

I want to know exactly what can be configured in crush.json, and if there are any standards for it. Of course, there are some example displays in the readme, and I have seen them.

Also, in Crush's TUI interface, there are many tools, and many new tools have been added. But I honestly don’t know what some of these tools actually do. For example, pressing Ctrl+o shows 'open editor', but on my side it only opens Notepad and then reports that the file cannot be found. I can only find part of the information in the readme, but when problems occur, I don’t know where to go to find a solution.

I am a student, and this is my first time using a CLI tool. I really fell in love with Crush at first sight, but as a beginner, I really don’t know how to use it.

Thank you！

[meowgorithm]

This is perfect feedback: thank you. I’m going to move to this to Discussions for a more informal conversation around this, and to keep the issue tracker clean, but please rest assured that this is something we take seriously and something that does need to happen.

[mukramp]

I strongly agree! I have a bit more time to explore Crush at the moment, but I feel many features are mentioned somewhere (Readme/ReleaseNotes), but I would need to look into the code how they are implemented if I wanted to know what I can do with them.

I also feel like the "single Readme for all information" approach is hitting its limits.

[inquam]

I join the choir :)

I read about agent skills in the README so I dabbled a bit with building some. Then I stumbled across the sister/brother of skills, commands. I used them a bit in Claude Code and wondered if they worked in Crush. I found no mention of them in the README so I just decided to test, and it worked just fine.

When I later looked at the code I saw a file for handling commands, so if I would have done that earlier I would have known. But many people probably don't jump into the code but instead just use the application.

I have wondered over how Crush handles system prompts, if you can set them yourself, if you can inject something to them or if Crush just handles it all (which is my guess), but can't find any documentation about it. Strategies for running a single vs multiple models, like one reasoning for planning and another for doing work, if that is a good idea or not etc would be good for a newcomer. In fact, what actually happens when Crush runs out of context or when you run "Summarize Session" and what is stored and not would be interesting to be able to read about and understand.

And some guides to setting up and configuring well known LSP's to have them work in Crush would be very helpful. The amount of trial and error I have done... hehe

[monooso]

I'm a little surprised this isn't getting more attention.

Crush may be vastly superior to the (better documented) competition, but there's really no way of knowing without an inordinate amount of trial and error.

[andreynering]

In fact, we're working on a new documentation.

Let us know if there are any specific things you miss.

[monooso]

That's great news.

• Settings and configuration information would be great. I've been digging around the schema, which works, but is a slog.
• Command line options are sort-of discoverable with enough trial and error, but I'm mostly just guessing and hoping ¹.

Footnotes

1. Guessing and Hoping are also the names of my chosen LLM models. ↩

[ozgurulukir]

Need a documentation put it in the release, LLM.txt or deep wiki or dedicated web page eg at GitHub