{"id":30940775,"url":"https://github.com/kodustech/kodus-ai","last_synced_at":"2026-05-13T03:05:28.099Z","repository":{"id":285815474,"uuid":"956679248","full_name":"kodustech/kodus-ai","owner":"kodustech","description":"AI Code Review with Full Control Over Model Choice and Costs.","archived":false,"fork":false,"pushed_at":"2026-04-18T15:29:50.000Z","size":122560,"stargazers_count":1049,"open_issues_count":56,"forks_count":95,"subscribers_count":9,"default_branch":"main","last_synced_at":"2026-04-18T15:32:50.732Z","etag":null,"topics":["ai","ai-agents","ai-code-review","ai-coding-tools","code-review","coding-assistant","generative-ai","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://kodus.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kodustech.png","metadata":{"files":{"readme":"README-SETUP.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-03-28T17:05:19.000Z","updated_at":"2026-04-18T14:22:13.000Z","dependencies_parsed_at":"2025-06-26T00:18:44.032Z","dependency_job_id":"31a882c8-d0e0-4f14-8b58-e584a0e20969","html_url":"https://github.com/kodustech/kodus-ai","commit_stats":null,"previous_names":["kodustech/kodus-ai"],"tags_count":161,"template":false,"template_full_name":null,"purl":"pkg:github/kodustech/kodus-ai","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kodustech%2Fkodus-ai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kodustech%2Fkodus-ai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kodustech%2Fkodus-ai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kodustech%2Fkodus-ai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kodustech","download_url":"https://codeload.github.com/kodustech/kodus-ai/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kodustech%2Fkodus-ai/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32069440,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T21:26:33.338Z","status":"ssl_error","status_checked_at":"2026-04-20T21:26:22.081Z","response_time":94,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","ai-agents","ai-code-review","ai-coding-tools","code-review","coding-assistant","generative-ai","hacktoberfest"],"created_at":"2025-09-10T21:01:34.134Z","updated_at":"2026-04-20T23:01:25.623Z","avatar_url":"https://github.com/kodustech.png","language":"TypeScript","funding_links":[],"categories":["\u003ca name=\"TypeScript\"\u003e\u003c/a\u003eTypeScript","Code Review \u0026 Collaboration","TypeScript"],"sub_categories":["Other IDEs"],"readme":"# 🚀 Kodus AI - Quick Setup Guide\n\nThis guide helps you run the Kodus monorepo locally (backend + web) in a few minutes.\n\n## Prerequisites\n\n- Node.js 22.x\n- Yarn or NPM\n- Docker\n- OpenSSL (usually pre-installed on macOS/Linux)\n\n## Quick Start (Recommended)\n\nFor first-time setup, simply run:\n\n```bash\nyarn setup\n```\n\nThis automated script will:\n- ✅ Check all dependencies\n- 📦 Install project dependencies\n- 🔧 Create and configure your `.env` file\n- 🔐 Generate secure keys automatically\n- 🐳 Set up Docker networks\n\nAfter setup, start the stack:\n\n```bash\nyarn docker:start\n```\n\n`yarn docker:start` already runs backend migrations and seed automatically during API startup.\n\n## Validate `.env` with Doctor\n\nAfter editing `.env`, run:\n\n```bash\nyarn env:doctor\n```\n\nScope-specific checks:\n\n```bash\nyarn env:doctor:backend\nyarn env:doctor:web\n```\n\nThe doctor validates required variables and shows warnings for optional OAuth fields used only when those integrations are enabled.\n\n## Manual Configuration\n\nIf you prefer manual setup or need to customize settings:\n\n1. **Install dependencies:**\n   ```bash\n   yarn install\n   ```\n\n2. **Configure environment:**\n   ```bash\n   cp .env.example .env\n   ```\n\n3. **Add your OpenAI API key to `.env`:**\n   ```env\n   API_OPEN_AI_API_KEY=your_api_key_here\n   ```\n\n4. **Start services:**\n   ```bash\n   yarn docker:start\n   ```\n\n5. **Migrations + seed (automatic with `yarn docker:start`):**\n   no manual command needed in the default Docker flow.\n\n### Conectar aos bancos de QA/Prod\n\n1. Gere o arquivo de variáveis do ambiente desejado (`aws ssm` requerido):\n   ```bash\n   ./scripts/dev/fetch-env-qa.sh qa    # ou ./scripts/dev/fetch-env-prod.sh prod\n   ```\n2. Suba os serviços (por padrão o compose usa o `.env` da raiz). Se preferir outro arquivo, exporte `ENV_FILE` antes do comando:\n   ```bash\n   docker compose -f docker-compose.dev.yml up\n   # ou, para usar o arquivo baixado via fetch:\n   ENV_FILE=.env.qa docker compose -f docker-compose.dev.yml up\n   ```\n3. Caso queira incluir os bancos locais no mesmo comando, habilite o perfil `local-db`:\n   ```bash\n   ENV_FILE=.env.qa docker compose --profile local-db -f docker-compose.dev.yml up\n   ```\n   Esse perfil também sobe o RabbitMQ local para desenvolvimento.\n   O perfil pode ser combinado com `down`, `logs` e demais subcomandos do Docker Compose.\n   Se estiver usando apenas o `.env` principal, remova o prefixo `ENV_FILE=...`.\n\n\u003e Prefere um atalho? Rode `yarn docker:start:env qa` ou `yarn docker:start:env prod` para ajustar `API_DATABASE_ENV` e subir o compose (usando o `.env` por padrão).\n\n\u003e Preferindo manter apenas o `.env`, defina manualmente as credenciais remotas e exporte `API_DATABASE_ENV=production` ou `API_DATABASE_ENV=homolog` antes de subir:\n\u003e ```bash\n\u003e API_DATABASE_ENV=production docker compose -f docker-compose.dev.yml up\n\u003e ```\n\u003e Assim o serviço usa os hosts remotos mesmo carregando o `.env` padrão.\n\n## Available Scripts\n\n| Command | Description |\n|---------|-------------|\n| `yarn setup` | Complete first-time setup |\n| `yarn env:doctor` | Validate required `.env` variables (backend + web) |\n| `yarn env:doctor:backend` | Validate only backend required variables |\n| `yarn env:doctor:web` | Validate only web required variables |\n| `yarn dev:health-check` | Verify all services are running |\n| `yarn docker:start` | Start backend + web + local infrastructure |\n| `yarn dev:restart` | Restart all services |\n| `yarn dev:stop` | Stop all services |\n| `yarn dev:logs` | View service logs |\n| `yarn dev:clean` | Clean restart (removes Docker cache) |\n| `yarn web:dev` | Run only web app locally (without Docker) |\n\n## Health Check\n\nTo verify everything is working:\n\n```bash\nyarn dev:health-check\n```\n\n## Service Endpoints\n\nOnce running, you can access:\n\n- **Web App:** http://localhost:3000\n- **API Health:** http://localhost:3001/health\n- **API Base:** http://localhost:3001\n- **RabbitMQ Management UI:** http://localhost:15672 (default user/pass: `dev` / `devpass`)\n\n## Troubleshooting\n\nIf you encounter issues:\n\n1. **Check service status:**\n   ```bash\n   yarn dev:health-check\n   ```\n\n2. **View logs:**\n   ```bash\n   yarn dev:logs\n   ```\n\n3. **Clean restart:**\n   ```bash\n   yarn dev:clean\n   ```\n\n4. **Manual container check:**\n   ```bash\n   docker ps\n   ```\n\n## Getting API Keys\n\n- **OpenAI:** https://platform.openai.com/api-keys\n- **Google AI:** https://cloud.google.com/docs/authentication/api-keys\n- **Anthropic:** https://docs.anthropic.com/claude/reference/getting-started-with-the-api\n\n## Need Help?\n\nIf you're still having trouble, check our [full documentation](./CONTRIBUTING.md) or open an issue.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkodustech%2Fkodus-ai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkodustech%2Fkodus-ai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkodustech%2Fkodus-ai/lists"}