mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-03 22:02:08 +03:00
Enable key security feature flags by default and add a per-token/IP relay rate limit to reduce leaked token blast radius. Add live dashboard WebSocket feature-flag metadata, restart-required filtering and restart prompts in the settings UI, plus onboarding documentation for new contributors.
4.0 KiB
4.0 KiB
Welcome to OmniRoute
How We Use Claude
Based on diegosouzapw's usage over the last 30 days:
Work Type Breakdown: Build Feature ████████████████████ 50% Plan Design ██████████░░░░░░░░░░ 25% Improve Quality ██████░░░░░░░░░░░░░░ 15% Write Docs ████░░░░░░░░░░░░░░░░ 10%
Top Skills & Commands: no slash commands captured in this window
Top MCP Servers: no MCP usage captured in this window
Your Setup Checklist
Codebases
- omniroute — https://github.com/diegosouzapw/omniroute
- OpenCode_Ecosystem (fork) — https://github.com/diegosouzapw/OpenCode_Ecosystem
- OpenCode_Ecosystem (upstream) — https://github.com/MarceloClaro/OpenCode_Ecosystem
MCP Servers to Activate
- none required from current usage. If you'll be working on OmniRoute itself, ask the team about the project's own embedded MCP server at
/api/mcp/stream.
Skills to Know About
- no skills surfaced from usage data. The team's workflow leaned heavily on direct file edits, git/gh CLI, and subagent dispatch for parallel work — Claude figures these out from context.
Team Tips
- Read
CLAUDE.mdfirst. It has hard rules that override defaults — e.g. never write raw SQL in routes (usesrc/lib/db/modules), never addCo-Authored-By: Claudeto commits, error responses must go throughbuildErrorBody()/sanitizeErrorMessage(). - Subagents for parallel work. When tasks are independent, dispatch multiple sonnet subagents in one message instead of doing them yourself. Always audit
git diffafter a subagent finishes — its summary describes intent, not necessarily the result. - Conventional Commits for everything:
feat(scope):,fix(scope):,chore(scope):,docs:. Scopes used here includedb,sse,oauth,dashboard,api,agents,plugin,skills,commands. - Run the full validation suite before declaring done —
npm run check(lint + tests) at minimum;npm run test:coverageif you changed production code. Hard gate: 75/75/75/70 (statements/lines/functions/branches). - Husky pre-push runs unit tests. Don't
--no-verifypast it without explicit approval — the project documents this as a hard rule.
Get Started
- Clone the repo and run
npm install(auto-generates.envfrom.env.example). - Generate secrets:
openssl rand -base64 48forJWT_SECRET,openssl rand -hex 32forAPI_KEY_SECRET. Paste into.env. npm run dev→ dashboard athttp://localhost:20128.- Read
docs/architecture/REPOSITORY_MAP.mdfor the file layout, thendocs/architecture/ARCHITECTURE.mdfor how requests flow. - For a first PR: pick something from
_tasks/if there's a backlog, or grep for// TODOand pick a small one. Runnpm run checkbefore opening the PR.