docs: update coverage, READMEs, and add security tests
- Update COVERAGE.md to reflect completed features (now ~60%) - Update main README with features and tools list - Update CLI README with streaming options - Expand API tests from 5 to 11 (add stream endpoint tests) - Add 14 security tests for path traversal, command injection - Total tests: 109 (up from 88) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
@@ -2,6 +2,13 @@
|
||||
|
||||
A Claude Code-inspired development assistant powered by local LLMs via Ollama.
|
||||
|
||||
## Features
|
||||
|
||||
- **Explore Agent** - Search, read, and understand codebases
|
||||
- **8 Tools** - File read/write, glob, grep, bash, web search
|
||||
- **Streaming** - Real-time response display
|
||||
- **Self-hosted** - Runs on your own hardware with Ollama
|
||||
|
||||
## Structure
|
||||
|
||||
This is a monorepo containing three subprojects:
|
||||
@@ -44,25 +51,28 @@ pip install -e .
|
||||
webber-cli status
|
||||
```
|
||||
|
||||
### 3. Load a Sandbox Project
|
||||
### 3. Explore with Webber
|
||||
|
||||
```bash
|
||||
# From repo root
|
||||
./sandbox.sh list
|
||||
./sandbox.sh load calculator-cli
|
||||
# One-shot exploration
|
||||
webber-cli explore "find all bugs in the code" -d /path/to/project
|
||||
|
||||
cd webber-sandbox
|
||||
python3.12 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
# Interactive chat
|
||||
webber-cli chat -d /path/to/project
|
||||
```
|
||||
|
||||
### 4. Explore with Webber
|
||||
## Available Tools
|
||||
|
||||
```bash
|
||||
cd webber-cli
|
||||
webber-cli explore "find all bugs in the code" -d ../webber-sandbox
|
||||
```
|
||||
| Tool | Description |
|
||||
|------|-------------|
|
||||
| `read_file` | Read file contents with line numbers |
|
||||
| `glob_files` | Find files by pattern |
|
||||
| `grep_content` | Search file contents with regex |
|
||||
| `bash_readonly` | Safe bash commands (ls, git status, etc.) |
|
||||
| `edit_file` | Find-and-replace editing |
|
||||
| `write_file` | Create/overwrite files |
|
||||
| `bash` | Full bash with safety controls |
|
||||
| `web_search` | Search web via SearXNG |
|
||||
|
||||
## Versioning
|
||||
|
||||
@@ -76,11 +86,13 @@ This project uses prefixed tags for independent release cycles:
|
||||
- Python 3.12+
|
||||
- Ollama running with `mistral-nemo:latest` model
|
||||
- Docker (for production deployment)
|
||||
- SearXNG (optional, for web search)
|
||||
|
||||
## Documentation
|
||||
|
||||
- `webber-api/AGENTS.md` - API development guidelines
|
||||
- `webber-api/docs/` - Architecture and coverage docs
|
||||
- `webber-api/docs/COVERAGE.md` - Feature coverage and roadmap
|
||||
- `webber-api/docs/architecture.md` - System architecture
|
||||
- `webber-cli/README.md` - CLI usage guide
|
||||
|
||||
## License
|
||||
|
||||
Reference in New Issue
Block a user