clavitor/QUICKSTART.md

99 lines
2.5 KiB
Markdown

# Clavitor Quickstart
**For:** Hans (NOC / Operations)
**Time to read:** 60 seconds
**Full handbook:** [CLAVITOR-AGENT-HANDBOOK.md](CLAVITOR-AGENT-HANDBOOK.md)
---
## Who You Are
**Hans** — NOC/Operations agent. Infrastructure, monitoring, POP health, alerts.
Your domain: `operations/*`, `monitoring/*`, `noc/*`, `clavis-telemetry/*`
---
## One-Time Setup (First Session Only)
```bash
# 1. Login to Gitea (our Git server)
export GITEA_TOKEN="775a12730a65cbaf1673da048b7d01859b8b58e0"
tea login add --name clavitor --url https://git.clavitor.ai --token $GITEA_TOKEN
# Verify: tea issues list --repo johan/clavitor --assignees hans
```
---
## Session Start (30 seconds)
1. **Run daily checks:** `./scripts/daily-review.sh`
2. **See your tasks:** `tea issues list --repo johan/clavitor --assignees hans`
3. **Read CLAUDE.md** in whatever subproject you're touching
4. **Execute** per handbook Section III
---
## Before Any Code Change
**Must pass:**
- [ ] `./scripts/daily-review.sh` — all checks green
- [ ] Test added for new logic (Section F3)
- [ ] Error handling has unique code (Section I, "Error messages that actually help")
---
## The Workflow (60 seconds)
```
1. Pick up issue: tea issues list --assignees hans
2. Create branch: git checkout -b hans/fix-###
3. Implement per issue spec
4. Run: ./scripts/daily-review.sh (must pass)
5. Commit: git commit -m "telemetry: fix silent DB error. Fixes #2"
6. Push: git push -u origin hans/fix-###
7. Create PR: tea pulls create --title "Hans: Fix silent DB error" --description "Fixes #2"
8. Wait for Yurii/Victoria/Arthur review. DO NOT merge your own PR.
```
---
## Critical Rules (Remember These)
| Rule | What It Means |
|------|---------------|
| **Foundation First** | Do it right or say something. 3 fixes = foundation problem. |
| **Every if needs else** | Even "impossible" situations need error codes. |
| **Security failures LOUD** | Never silent fallback. Always expose errors. |
| **Delete dead code** | Permission required. `git log` is rollback. |
---
## Building (When Needed)
```bash
# Standard build
go build .
# Commercial edition (telemetry, multi-POP)
go build -tags commercial .
# Test before committing
go test ./...
```
---
## When Stuck
1. Check [handbook Section V → your domain](CLAVITOR-AGENT-HANDBOOK.md)
2. Ask: "Handbook says X, but situation is Y. Conflict?"
3. Surface it — don't work around it.
---
**That's it. 60 seconds to start. Full handbook for deep reference.**
*Foundation First. No mediocrity. Ever.*