first commit
This commit is contained in:
61
README.md
Normal file
61
README.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# WiseClaw
|
||||
|
||||
WiseClaw is a local-first personal assistant for macOS. It runs a FastAPI backend, uses Ollama for local LLM access, exposes a Telegram bot, and includes a React admin panel for settings, logs, and memory management.
|
||||
|
||||
## Planned capabilities
|
||||
|
||||
- Telegram chat with whitelist support
|
||||
- Local Ollama integration for `qwen3.5:4b`
|
||||
- Brave or SearXNG-backed web search
|
||||
- Apple Notes integration via AppleScript
|
||||
- File read/write tools
|
||||
- Terminal execution with policy modes
|
||||
- SQLite-backed memory, settings, and audit logs
|
||||
- macOS Keychain for secrets
|
||||
|
||||
## Repository layout
|
||||
|
||||
- `backend/` FastAPI app and WiseClaw core modules
|
||||
- `frontend/` React admin panel
|
||||
- `docs/` architecture and rollout notes
|
||||
|
||||
## Local development
|
||||
|
||||
### Backend
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
python3.12 -m venv .venv312
|
||||
source .venv312/bin/activate
|
||||
pip install .
|
||||
uvicorn app.main:app --reload
|
||||
```
|
||||
|
||||
### Frontend
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### Smoke checks
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
source .venv312/bin/activate
|
||||
uvicorn app.main:app --reload
|
||||
```
|
||||
|
||||
Then in another shell:
|
||||
|
||||
```bash
|
||||
curl http://127.0.0.1:8000/health
|
||||
curl http://127.0.0.1:8000/bootstrap
|
||||
curl http://127.0.0.1:8000/admin/integrations/ollama
|
||||
curl http://127.0.0.1:8000/admin/integrations/telegram
|
||||
```
|
||||
|
||||
## Environment bootstrap
|
||||
|
||||
Copy `.env.example` to `.env` and fill in only the values you need for the first boot. Secrets that are changed from the admin panel should be written to Keychain, not back to `.env`.
|
||||
Reference in New Issue
Block a user