Skip to content

Commit 6f1670b

Browse files
clanker-loverclaude
andcommitted
Update README for setup wizard, GUI launcher, and always-visible code buttons
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 0e35887 commit 6f1670b

1 file changed

Lines changed: 31 additions & 11 deletions

File tree

README.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Blocks are **nested** — directories contain files, files contain classes, clas
2222

2323
### Code actions
2424

25-
Every analyzed block gets a toolbar with one-click actions:
25+
Every block gets a toolbar with one-click actions (no AI analysis needed):
2626

2727
| Button | What it does |
2828
|--------|-------------|
@@ -56,6 +56,12 @@ pip install -e .
5656

5757
### Run
5858

59+
**Setup wizard** — just run `codedocent` with no arguments:
60+
```bash
61+
codedocent
62+
```
63+
The wizard walks you through picking a folder, detecting Ollama, choosing a model, and selecting a mode. No flags to memorize.
64+
5965
**Interactive mode** (recommended) — instant load, AI analyzes each block on click:
6066
```bash
6167
codedocent /path/to/any/codebase
@@ -73,10 +79,20 @@ codedocent /path/to/any/codebase --full
7379
codedocent /path/to/any/codebase --text
7480
```
7581

82+
**GUI launcher** — a graphical window with folder picker, model dropdown, and mode selector:
83+
```bash
84+
codedocent --gui
85+
# or use the standalone entry point:
86+
codedocent-gui
87+
```
88+
Requires tkinter (usually included with Python; on Ubuntu: `sudo apt install python3-tk`).
89+
7690
### Options
7791

7892
| Flag | Description |
7993
|------|-------------|
94+
| *(no args)* | Launch interactive setup wizard |
95+
| `--gui` | Open GUI launcher (tkinter) |
8096
| `--full` | Analyze everything upfront, output static HTML |
8197
| `--text` | Print text tree to terminal (no browser) |
8298
| `--no-ai` | Skip AI summaries, show structure only |
@@ -131,27 +147,31 @@ Warnings roll up through the tree: a file inherits the worst quality of its func
131147

132148
```
133149
codedocent/
134-
├── cli.py Command-line interface and entry point
135-
├── scanner.py File discovery with .gitignore support
136-
├── parser.py AST parsing via tree-sitter
137-
├── analyzer.py AI summaries, quality scoring, caching
138-
├── editor.py Code replacement with backup safety
139-
├── renderer.py HTML generation (static + interactive)
140-
├── server.py Local server for interactive mode
150+
├── cli.py Command-line interface, setup wizard, entry point
151+
├── gui.py Tkinter GUI launcher
152+
├── ollama_utils.py Shared Ollama detection and model listing
153+
├── scanner.py File discovery with .gitignore support
154+
├── parser.py AST parsing via tree-sitter
155+
├── analyzer.py AI summaries, quality scoring, caching
156+
├── editor.py Code replacement with backup safety
157+
├── renderer.py HTML generation (static + interactive)
158+
├── server.py Local server for interactive mode
141159
└── templates/
142160
└── interactive.html Single-page app UI
143161
```
144162

145163
## Current status
146164

147165
- Scanner, parser, renderer, analyzer, editor, server, CLI — all built and tested
166+
- Interactive setup wizard when run with no arguments
167+
- GUI launcher via `--gui` flag or `codedocent-gui` entry point
148168
- Interactive navigation with lazy AI analysis
169+
- Code action buttons (Show Code, Export, Copy for AI, Replace) available immediately — no AI analysis required
149170
- Static HTML full-analysis mode with parallel workers
150-
- Code actions — Show Code, Export Code, Copy for AI, Replace Code
151171
- Code replacement with `.bak` backup and cache invalidation
152172
- Quality scoring with two-tier thresholds and warning rollup across the tree
153-
- pip-installable package with `codedocent` CLI entry point
154-
- 75 tests passing
173+
- pip-installable package with `codedocent` and `codedocent-gui` CLI entry points
174+
- 93 tests passing
155175
- Code quality: pylint 10/10, bandit/flake8/mypy all clean
156176

157177
## License

0 commit comments

Comments
 (0)