Skip to main content
Glama
README.md
<div align="center">

# πŸ”¨ Forja

**Forje seu fluxo de trabalho de engenharia.** Companion do Claude Code: agents, skills e scripts orquestrados, expostos via MCP.

Jira Β· AnΓ‘lise de repositΓ³rios Β· PadrΓ΅es de commit/PR/DevOps Β· RelatΓ³rios Β· Slides & infogrΓ‘ficos Β· RAG sobre a base de conhecimento

</div>

---

## O que Γ©

Forja Γ© uma plataforma modular que reΓΊne vΓ‘rios **agents** especializados (baseados no **Claude Agent SDK**), **skills** reutilizΓ‘veis e **scripts**. Ele foi pensado como uma **ferramenta auxiliar ao Claude Code** (e similares β€” Cursor, Claude Desktop): expΓ΅e os agents como **tools MCP** que vocΓͺ aciona de dentro da sua sessΓ£o de cΓ³digo. HΓ‘ tambΓ©m uma **interface web (FastAPI + dashboard)** como cockpit local opcional e um **CLI**.

- **MCP server** (principal) β€” os agents viram tools no Claude Code/Cursor/Claude Desktop. Veja [`docs/mcp.md`](docs/mcp.md).
- **Dashboard web** (cockpit) β€” executar agents por clique e revisar resultados/artefatos.
- **CLI** β€” `forja run <agent>` para automaΓ§Γ΅es.

### Agents / mΓ³dulos

| MΓ³dulo | Papel |
| --- | --- |
| **Jira** | Analisar e controlar tasks no Jira (via MCP Atlassian): status, backlog, triagem, resumos. |
| **Repo Analysis** | Varrer e analisar os diversos repositΓ³rios de serviΓ§os/projetos: saΓΊde, dependΓͺncias, convenΓ§Γ΅es, dΓ©bitos. |
| **Commit / PR / DevOps** | Gerar bons padrΓ΅es de commit (Conventional Commits), descriΓ§Γ΅es de PR e prΓ‘ticas de DevOps/CI. |
| **Reports** | Montar relatΓ³rios (status, sprint, incidentes) a partir de dados do Jira, dos repos e do RAG. |
| **Slides & Infographics** | Conectar ao NotebookLM para gerar slides e infogrΓ‘ficos a partir dos relatΓ³rios/base. |
| **RAG** | Busca semΓ’ntica sobre a base de documentos e `.md` gerados de outros chamados e projetos. |

Tudo Γ© exposto por um **dashboard web** e por uma **API** que orquestra os agents.

## Arquitetura (visΓ£o rΓ‘pida)

```
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                  Web Dashboard + API (FastAPI)            β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                β”‚
        β”Œβ”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”      registry + runtime
        β”‚  Orchestrator  β”‚  ── Claude Agent SDK ──┐
        β””β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜                        β”‚
   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”
β”Œβ”€β”€β–Όβ”€β”€β”   β”Œβ”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”   β”Œβ”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β” β”Œβ”€β”€β–Όβ”€β”€β”€β”€β”  β”Œβ”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”
β”‚Jira β”‚   β”‚Repo Anal. β”‚   β”‚Commit/PR/  β”‚ β”‚Reportsβ”‚  β”‚Slides/    β”‚
β”‚agentβ”‚   β”‚  agent    β”‚   β”‚DevOps agentβ”‚ β”‚ agent β”‚  β”‚Infographicβ”‚
β””β”€β”€β”¬β”€β”€β”˜   β””β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”˜   β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”¬β”€β”€β”€β”€β”˜  β””β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”˜
   β”‚            β”‚                β”‚          β”‚             β”‚
β”Œβ”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”
β”‚  Integrations: Jira (MCP) Β· Git repos Β· NotebookLM          β”‚
β”‚  RAG: embeddings (configurΓ‘vel) + vector store (Chroma)     β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
```

Detalhes em [`docs/architecture.md`](docs/architecture.md).

## ComeΓ§ando

```bash
# 1. Criar e ativar o ambiente
python -m venv .venv
# Windows (PowerShell):  .venv\Scripts\Activate.ps1
# Linux/macOS:           source .venv/bin/activate

# 2. Instalar em modo editΓ‘vel (dev)
pip install -e ".[dev]"

# 3. Configurar variΓ‘veis
cp .env.example .env   # e preencha as chaves

# 4. Subir o dashboard
forja serve
# ou:  uvicorn forja.web.app:app --reload
```

Scripts de bootstrap prontos em [`scripts/`](scripts/) (`bootstrap.ps1` / `bootstrap.sh`).

### Usar com o Claude Code (MCP)

```bash
pip install -e ".[mcp]"
forja mcp            # sobe o servidor MCP (stdio)
```

Registre no Claude Code (copie `.mcp.json.example` para `.mcp.json`) ou:

```bash
claude mcp add forja -- ./.venv/Scripts/python.exe -m forja.mcp_server
```

Os agents ficam disponΓ­veis como tools `forja_jira`, `forja_rag`, `forja_reports`, etc. Detalhes em [`docs/mcp.md`](docs/mcp.md).

## Fluxo de desenvolvimento (Git Flow)

- `main` β€” produΓ§Γ£o, sempre estΓ‘vel, com tags de release.
- `develop` β€” integraΓ§Γ£o contΓ­nua das features.
- `feature/*` β€” uma funcionalidade por branch, PR para `develop`.
- `release/*` β€” estabilizaΓ§Γ£o, bump de versΓ£o e CHANGELOG, PR para `main` + tag.
- `hotfix/*` β€” correΓ§Γ£o urgente a partir de `main`.

Versionamento **SemVer**, histΓ³rico em [`CHANGELOG.md`](CHANGELOG.md). Guia completo em [`docs/gitflow.md`](docs/gitflow.md) e helper em [`scripts/new_feature.sh`](scripts/new_feature.sh).

## Estrutura

```
src/forja/        cΓ³digo da plataforma (orchestrator, agents, rag, integrations, web)
knowledge_base/   documentos .md que alimentam o RAG
docs/             arquitetura, git flow e docs por agent
scripts/          bootstrap e helpers de git flow
tests/            testes (pytest)
```

## LicenΓ§a

[MIT](LICENSE).

Maintenance

ActivityMaintained
ResponsivenessNo issues