docs: simplify README usage section and regenerate demo.gif#35
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8113ddfc99
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ```bash | ||
| # Start in current directory | ||
| cltree | ||
|
|
||
| # Start in specific directory | ||
| cltree --path /path/to/project | ||
|
|
||
| # Adjust tree width (10-50%) | ||
| cltree --tree-width 25 | ||
|
|
||
| # Show hidden files | ||
| cltree --show-hidden | ||
| ``` | ||
|
|
||
| ## Keyboard Shortcuts | ||
|
|
||
| | Key | Action | | ||
| |-----|--------| | ||
| | `Ctrl+Q` | Quit | | ||
|
|
||
| All other keystrokes are passed directly to Claude Code. | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### Command line options | ||
|
|
||
| ``` | ||
| Options: | ||
| -p, --path <PATH> Working directory [default: .] | ||
| -w, --tree-width <WIDTH> Tree panel width percentage (10-50) [default: 30] | ||
| -a, --show-hidden Show hidden files | ||
| -d, --depth <DEPTH> Max tree depth [default: 10] | ||
| -h, --help Print help | ||
| -V, --version Print version | ||
| ``` |
There was a problem hiding this comment.
Document the reserved Ctrl+Q key again
Removing the keyboard-shortcut section leaves no mention that Ctrl+Q is intercepted by cltree, even though src/app.rs still exits on that key in handle_key; this makes the docs misleading in the exact scenario where a user presses Ctrl+Q expecting it to be forwarded to Claude Code. Re-adding a short note about the reserved quit shortcut would prevent unexpected session termination.
Useful? React with 👍 / 👎.
Summary
Test plan
🤖 Generated with Claude Code