okam 0.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- okam-0.2.0/.agents/rules/governance-standards.md +43 -0
- okam-0.2.0/.agents/skills/deep-metadata-analysis/SKILL.md +25 -0
- okam-0.2.0/.agents/skills/knowledge-wiki/SKILL.md +49 -0
- okam-0.2.0/.agents/skills/memory-maintenance/SKILL.md +19 -0
- okam-0.2.0/.agents/workflows/deep-metadata-pipeline.md +27 -0
- okam-0.2.0/.github/workflows/validate-okf.yml +31 -0
- okam-0.2.0/.gitignore +13 -0
- okam-0.2.0/AGENTS.md +52 -0
- okam-0.2.0/LICENSE +21 -0
- okam-0.2.0/PKG-INFO +134 -0
- okam-0.2.0/Projeto_okam.md +33 -0
- okam-0.2.0/QUICKSTART.md +102 -0
- okam-0.2.0/README.md +121 -0
- okam-0.2.0/docs/concepts/deep-metadata.md +60 -0
- okam-0.2.0/docs/concepts/git-hooks.md +78 -0
- okam-0.2.0/docs/concepts/guided-tours.md +64 -0
- okam-0.2.0/docs/concepts/llm-wiki.md +47 -0
- okam-0.2.0/docs/concepts/okf-format.md +68 -0
- okam-0.2.0/docs/diagrams/architecture.mmd +34 -0
- okam-0.2.0/hooks/commit-msg +58 -0
- okam-0.2.0/hooks/pre-commit +114 -0
- okam-0.2.0/hooks/pre-push +36 -0
- okam-0.2.0/knowledge/raw-sources/.gitkeep +1 -0
- okam-0.2.0/knowledge/scripts/okf_manager.py +59 -0
- okam-0.2.0/knowledge/wiki/architecture.md +30 -0
- okam-0.2.0/knowledge/wiki/getting-started.md +44 -0
- okam-0.2.0/knowledge/wiki/index.md +28 -0
- okam-0.2.0/landing/index.html +240 -0
- okam-0.2.0/landing/script.js +197 -0
- okam-0.2.0/landing/style.css +709 -0
- okam-0.2.0/pyproject.toml +27 -0
- okam-0.2.0/src/okam/__init__.py +1 -0
- okam-0.2.0/src/okam/cli.py +392 -0
- okam-0.2.0/src/okam/hooks.py +213 -0
- okam-0.2.0/src/okam/manager.py +155 -0
- okam-0.2.0/src/okam/skill_creator.py +166 -0
- okam-0.2.0/templates/project-note.md +28 -0
- okam-0.2.0/templates/skill-template.md +29 -0
- okam-0.2.0/templates/tour-template.md +37 -0
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# 🌐 Padrões de Governança
|
|
2
|
+
|
|
3
|
+
Este manual estabelece os padrões técnicos para projetos que utilizam o framework Okam.
|
|
4
|
+
|
|
5
|
+
## 📂 Estrutura de Projeto Padrão
|
|
6
|
+
|
|
7
|
+
- `.agents/`: Configuração de agentes de IA.
|
|
8
|
+
- `rules/`: Documentos de governança e regramentos técnicos.
|
|
9
|
+
- `skills/`: Capacidades modulares dos agentes.
|
|
10
|
+
- `workflows/`: Fluxos de trabalho e automações.
|
|
11
|
+
- `knowledge/`: Base de conhecimento persistente.
|
|
12
|
+
- `wiki/`: Páginas de síntese (OKF).
|
|
13
|
+
- `raw-sources/`: Fontes brutas e imutáveis.
|
|
14
|
+
- `scripts/`: Utilitários de validação e manutenção.
|
|
15
|
+
- `templates/`: Templates reutilizáveis para novos documentos.
|
|
16
|
+
- `docs/`: Documentação técnica e conceitual.
|
|
17
|
+
|
|
18
|
+
## 📝 Documentação e Código
|
|
19
|
+
|
|
20
|
+
- **README.md**: Todo projeto deve ter um arquivo explicando o objetivo e como rodar.
|
|
21
|
+
- **Comentários**: Explicar o "Porquê", não apenas o "O quê".
|
|
22
|
+
- **Idioma**: Código (variáveis/funções) em Inglês; Documentação em Português (PT-BR).
|
|
23
|
+
|
|
24
|
+
## 🚀 Fluxo de Trabalho Git
|
|
25
|
+
|
|
26
|
+
- **Commits**: Atômicos e descritivos.
|
|
27
|
+
- **Limpeza**: Nunca subir `node_modules`, `.env` ou artefatos de build.
|
|
28
|
+
|
|
29
|
+
## 🛡️ Segurança e Qualidade
|
|
30
|
+
|
|
31
|
+
- **Variáveis de Ambiente**: Credenciais e tokens SEMPRE em arquivos `.env` protegidos.
|
|
32
|
+
- **Refatoração**: Só deve ser feita se houver um ganho claro em manutenibilidade ou performance medível.
|
|
33
|
+
|
|
34
|
+
## ⚖️ Priorização
|
|
35
|
+
|
|
36
|
+
- Antes de iniciar qualquer tarefa, os agentes DEVEM consultar o contexto do projeto.
|
|
37
|
+
- Priorizar implementações que gerem valor direto.
|
|
38
|
+
- Se a tarefa não estiver no escopo prioritário, confirmar se é uma tarefa rápida (Quick Win) ou se deve ser agendada.
|
|
39
|
+
|
|
40
|
+
## 🔄 Gestão de Sessão e Continuidade
|
|
41
|
+
|
|
42
|
+
- Ao final de cada sessão, o agente deve documentar o que foi feito e os próximos passos claros.
|
|
43
|
+
- O documento de handoff deve ser um prompt "pronto para uso" para o próximo agente.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: DeepMetadataAnalysis
|
|
3
|
+
description: Executa o pipeline de análise profunda em um projeto para extrair sua "alma" e atualizar a governança.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 🔭 Deep Metadata Analysis
|
|
7
|
+
|
|
8
|
+
Use esta skill para realizar uma análise holística de um projeto, inspirada no padrão "Understand Anything".
|
|
9
|
+
|
|
10
|
+
## 📋 Instruções de Execução
|
|
11
|
+
|
|
12
|
+
1. **Invocação:** O usuário solicita análise de um projeto específico.
|
|
13
|
+
2. **Execução das Fases:**
|
|
14
|
+
- Rode o **Scanner** (liste arquivos, leia configurações de projeto).
|
|
15
|
+
- Mude sua mentalidade para o **Relational** (deduza a regra de negócio lendo o código).
|
|
16
|
+
- Audite via **Governance** (compare com os guias de estilo em `.agents/rules/`).
|
|
17
|
+
3. **Padrão de Saída para o Índice:**
|
|
18
|
+
```markdown
|
|
19
|
+
### [Nome do Projeto]
|
|
20
|
+
- **Stack:** [Techs]
|
|
21
|
+
- **Objetivo:** [Breve resumo]
|
|
22
|
+
- **Fluxo:** [A -> B -> C]
|
|
23
|
+
- **Status de Governança:** [OK/Pendente]
|
|
24
|
+
```
|
|
25
|
+
4. **Finalização:** Link o projeto no `./knowledge/wiki/index.md` e confirme o sucesso.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: KnowledgeWiki
|
|
3
|
+
description: Operações de Ingest, Query e Lint para manter o sistema de conhecimento persistente.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 📚 Knowledge Wiki
|
|
7
|
+
|
|
8
|
+
Esta skill define as operações para manter o sistema de conhecimento persistente do workspace.
|
|
9
|
+
|
|
10
|
+
## Estrutura do Wiki
|
|
11
|
+
|
|
12
|
+
- **Localização**: `./knowledge/`
|
|
13
|
+
- **raw-sources/**: Fontes brutas, imutáveis (PDFs, Markdown clippado, logs).
|
|
14
|
+
- **wiki/**: Páginas de síntese geradas por IA seguindo o formato OKF.
|
|
15
|
+
|
|
16
|
+
## Operações Principais
|
|
17
|
+
|
|
18
|
+
### 1. Ingest (Ingestão)
|
|
19
|
+
|
|
20
|
+
Sempre que uma nova fonte for adicionada a `raw-sources/`:
|
|
21
|
+
|
|
22
|
+
1. Leia o conteúdo da fonte.
|
|
23
|
+
2. Identifique os temas, entidades e conceitos principais.
|
|
24
|
+
3. Compare com o conhecimento já existente no `wiki/`.
|
|
25
|
+
4. **Crie ou Atualize** páginas no `wiki/`.
|
|
26
|
+
5. Atualize o `index.md` e o `log.md`.
|
|
27
|
+
|
|
28
|
+
### 2. Query (Consulta)
|
|
29
|
+
|
|
30
|
+
Ao responder perguntas sobre o conhecimento acumulado:
|
|
31
|
+
|
|
32
|
+
1. Comece consultando o `index.md` do Wiki.
|
|
33
|
+
2. Siga os links para as páginas de síntese relevantes.
|
|
34
|
+
3. Se houver lacunas, consulte as `raw-sources/`.
|
|
35
|
+
4. Se a descoberta for valiosa, **protocole** a resposta como uma nova página no Wiki.
|
|
36
|
+
|
|
37
|
+
### 3. Lint (Auditoria)
|
|
38
|
+
|
|
39
|
+
Periodicamente, revise o Wiki em busca de:
|
|
40
|
+
|
|
41
|
+
- Contradições entre documentos novos e antigos.
|
|
42
|
+
- Páginas órfãs (sem links de entrada).
|
|
43
|
+
- Conceitos mencionados mas sem página própria.
|
|
44
|
+
|
|
45
|
+
## Padrões de Escrita
|
|
46
|
+
|
|
47
|
+
- Use links `[[Nome da Página]]` para referências cruzadas.
|
|
48
|
+
- Adicione frontmatter YAML no formato OKF (title, description, type, resource, timestamp, tags, parent).
|
|
49
|
+
- Valide antes de commitar: `python ./knowledge/scripts/okf_manager.py --validate`.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: MemoryMaintenance
|
|
3
|
+
description: Extrai lições aprendidas e destila no índice de conhecimento para evitar repetição de erros.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 🧠 Memory Maintenance
|
|
7
|
+
|
|
8
|
+
Esta skill deve ser invocada sempre que uma sessão de trabalho termina ou uma lição importante é aprendida.
|
|
9
|
+
|
|
10
|
+
## 🎯 Objetivo
|
|
11
|
+
|
|
12
|
+
Garantir que o "Subconsciente" do Workspace seja alimentado com informações úteis, evitando que agentes futuros repitam os mesmos erros ou perguntem as mesmas coisas.
|
|
13
|
+
|
|
14
|
+
## 📋 Fluxo de Trabalho
|
|
15
|
+
|
|
16
|
+
1. **Análise:** Revise o histórico da conversa e identifique decisões, bugs corrigidos ou preferências do usuário.
|
|
17
|
+
2. **Destilação:** Resuma a lição em 1 ou 2 frases curtas e diretas.
|
|
18
|
+
3. **Escrita:** Localize o arquivo `./knowledge/wiki/index.md` e adicione a lição na categoria correta.
|
|
19
|
+
4. **Confirmação:** Informe ao usuário qual lição foi "eternizada" na memória de governança.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Fluxo multi-agente para extração profunda de metadados e "alma" de projetos.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# 🌊 Workflow: Deep Metadata Extraction
|
|
6
|
+
|
|
7
|
+
Este workflow deve ser seguido para documentar e entender novos projetos ou atualizar a visão macro do workspace.
|
|
8
|
+
|
|
9
|
+
## 1. 🔍 Fase: Scanner (Técnico)
|
|
10
|
+
- Identificar stack principal (Linguagem, Frameworks).
|
|
11
|
+
- Listar dependências críticas (APIs externas, Bancos de Dados).
|
|
12
|
+
- Localizar pontos de entrada (`index.js`, `main.py`, etc.).
|
|
13
|
+
|
|
14
|
+
## 2. 🧠 Fase: Relational (Lógica e Negócio)
|
|
15
|
+
- Entender o "Porquê": Qual problema este projeto resolve?
|
|
16
|
+
- Mapear fluxos principais (ex: "Recebe webhook → Valida → Envia para Sheet").
|
|
17
|
+
- Identificar conexões com outros projetos do workspace.
|
|
18
|
+
|
|
19
|
+
## 3. ⚖️ Fase: Governance (Compliance)
|
|
20
|
+
- Verificar se segue o `governance-standards.md`.
|
|
21
|
+
- Checar se existem segredos expostos (vazamento de `.env`).
|
|
22
|
+
- Validar se a documentação local está alinhada com as regras de Agentes.
|
|
23
|
+
|
|
24
|
+
## 4. 🧪 Fase: Synthesis (Eternização)
|
|
25
|
+
- Destilar as fases anteriores em um bloco de metadados.
|
|
26
|
+
- Atualizar o índice de conhecimento em `./knowledge/wiki/index.md`.
|
|
27
|
+
- (Opcional) Gerar um grafo Mermaid se a complexidade for alta.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
name: OKF Compliance CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [ main, master ]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [ main, master ]
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
validate-okf:
|
|
11
|
+
name: Validate OKF Compliance
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
|
|
14
|
+
steps:
|
|
15
|
+
- name: Checkout Repository
|
|
16
|
+
uses: actions/checkout@v4
|
|
17
|
+
|
|
18
|
+
- name: Set up Python
|
|
19
|
+
uses: actions/setup-python@v5
|
|
20
|
+
with:
|
|
21
|
+
python-version: "3.10"
|
|
22
|
+
cache: "pip"
|
|
23
|
+
|
|
24
|
+
- name: Install Okam Package
|
|
25
|
+
run: |
|
|
26
|
+
python -m pip install --upgrade pip
|
|
27
|
+
pip install -e .
|
|
28
|
+
|
|
29
|
+
- name: Run OKF Validation
|
|
30
|
+
run: |
|
|
31
|
+
okam validate
|
okam-0.2.0/.gitignore
ADDED
okam-0.2.0/AGENTS.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# 🏛️ Governança de Agentes
|
|
2
|
+
|
|
3
|
+
Este documento define a arquitetura operacional de todos os Agentes de IA neste workspace. Objetivo: **Entendimento Holístico e Execução de Baixo Churn**.
|
|
4
|
+
|
|
5
|
+
## Visão Geral
|
|
6
|
+
|
|
7
|
+
Este é um repositório de inteligência com governança centralizada. A estratégia vive na raiz e o conhecimento vive em `./knowledge/`.
|
|
8
|
+
|
|
9
|
+
## Pipeline de Inteligência (Core Agent Pipeline)
|
|
10
|
+
|
|
11
|
+
Todos os agentes devem seguir o fluxo `/deep-metadata-pipeline` para garantir que o contexto nunca seja perdido:
|
|
12
|
+
|
|
13
|
+
1. **Scanner** (Técnico): Listar arquivos, identificar stacks e dependências críticas.
|
|
14
|
+
2. **Relational** (Psique): Deduzir o "porquê" do código e suas conexões inter-projeto.
|
|
15
|
+
3. **Governance** (Compliance): Auditar contra `governance-standards.md` e buscar segredos vazados.
|
|
16
|
+
4. **Synthesis** (Eternização): Destilar lições no Index e manter o **Wiki de Conhecimento** em `./knowledge/wiki/` como Memória Persistente de longo prazo.
|
|
17
|
+
|
|
18
|
+
## Wiki de Conhecimento (Memória Persistente - OKF)
|
|
19
|
+
|
|
20
|
+
O projeto utiliza o padrão **Open Knowledge Format (OKF)** para evitar a redescoberta de conhecimento do zero.
|
|
21
|
+
|
|
22
|
+
- **Princípio**: O conhecimento deve ser compilado e mantido atualizado no Wiki, não re-derivado a cada query.
|
|
23
|
+
- **Formato OKF**: Todos os arquivos do Wiki (`./knowledge/wiki/`) devem possuir frontmatter YAML contendo obrigatoriamente: `title`, `description`, `type`, `resource`, `timestamp`, `tags` e `parent`.
|
|
24
|
+
- **Valores de Type**: Os tipos devem ser `index`, `concept`, `architecture`, `runbook`, `entity` ou `benchmark`.
|
|
25
|
+
- **Validação**: Antes de criar ou modificar qualquer documento na Wiki, o agente deve validar a conformidade rodando `python ./knowledge/scripts/okf_manager.py --validate`.
|
|
26
|
+
- **Indexação**: Use `python ./knowledge/scripts/okf_manager.py --dump-index` para consultar rapidamente o índice de metadados de toda a Wiki antes de planejar mudanças.
|
|
27
|
+
- **Manutenção**: Use a skill `/knowledge-wiki` para operações de Ingest e Auditoria.
|
|
28
|
+
|
|
29
|
+
## Persistência e Economia de Contexto
|
|
30
|
+
|
|
31
|
+
- Agentes NÃO devem despejar dumps de logs ou análises brutas no chat.
|
|
32
|
+
- Resultados intermediários e planos complexos DEVEM ser gravados em artefatos organizados.
|
|
33
|
+
- O chat deve servir apenas para sínteses executivas e pedidos de aprovação.
|
|
34
|
+
|
|
35
|
+
## Convenções e Regras de Ouro
|
|
36
|
+
|
|
37
|
+
- **Slow is Fast**: Prefira soluções simples e legíveis em vez de abstrações complexas.
|
|
38
|
+
- **Respeito à Autonomia**: Subpastas são projetos independentes. Nunca compartilhe contextos entre eles.
|
|
39
|
+
- **Leitura Cirúrgica**: Evite ler arquivos extensos por completo. Use buscas específicas e leituras por blocos para economizar tokens.
|
|
40
|
+
- **Escrita Não-Destrutiva**: Evite sobrescrever arquivos inteiros. Dê preferência a edições incrementais ou cirúrgicas.
|
|
41
|
+
|
|
42
|
+
## Proibições Cruciais
|
|
43
|
+
|
|
44
|
+
- **Zero Temporary Files**: É proibido usar arquivos temporários para lógica de negócio ou dados persistentes.
|
|
45
|
+
- **No Secret Leaks**: Nunca grave segredos, dumps de banco ou chaves de API nos artefatos.
|
|
46
|
+
|
|
47
|
+
## Ciclo de Vida do Trabalho
|
|
48
|
+
|
|
49
|
+
1. **PLANNING**: Criar `implementation_plan.md` para mudanças de alto risco ou multi-arquivo.
|
|
50
|
+
2. **EXECUTION**: Mudanças pequenas, focadas e reversíveis.
|
|
51
|
+
3. **VERIFICATION**: Validar via `walkthrough.md` e evidências reais.
|
|
52
|
+
4. **HANDOFF**: Ao encerrar a sessão, resumir o progresso e apontar os próximos passos claros.
|
okam-0.2.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Okam Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
okam-0.2.0/PKG-INFO
ADDED
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: okam
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: Framework de governança de IA, memória persistente e gestão de conhecimento
|
|
5
|
+
Author: Juliano Ceconi
|
|
6
|
+
License: MIT
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
9
|
+
Classifier: Operating System :: OS Independent
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Requires-Python: >=3.8
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
|
|
14
|
+
<div align="center">
|
|
15
|
+
|
|
16
|
+
# ⬡ Okam
|
|
17
|
+
|
|
18
|
+
**Pare de Redescobrir. Comece a Governar.**
|
|
19
|
+
|
|
20
|
+
Framework open-source para governança de IA, memória persistente e gestão de conhecimento.
|
|
21
|
+
|
|
22
|
+
[](./LICENSE)
|
|
23
|
+
[](https://python.org)
|
|
24
|
+
[](https://github.com/juliano-ceconi/okam/pulls)
|
|
25
|
+
|
|
26
|
+
</div>
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## O Que É Isso?
|
|
31
|
+
|
|
32
|
+
**Okam** é um framework que resolve um problema simples: **seus agentes de IA não têm memória.**
|
|
33
|
+
|
|
34
|
+
Toda vez que você abre uma sessão com seu copilot, ele começa do zero. Sem contexto das decisões passadas, sem governança, sem reutilização de conhecimento.
|
|
35
|
+
|
|
36
|
+
Okam resolve isso com:
|
|
37
|
+
|
|
38
|
+
- 🏛️ **Governança** — Regras claras para seus agentes (AGENTS.md + pipeline de 4 fases)
|
|
39
|
+
- 🧩 **Skills** — Capacidades modulares reutilizáveis entre projetos
|
|
40
|
+
- 📚 **Wiki de Conhecimento** — Memória persistente no formato OKF (não é RAG)
|
|
41
|
+
- 🔍 **Pipeline de Metadados** — Extrai a "alma" dos seus projetos automaticamente
|
|
42
|
+
|
|
43
|
+
## Quick Start (5 minutos)
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# 1. Clone e instale localmente em modo de desenvolvimento
|
|
47
|
+
git clone https://github.com/juliano-ceconi/okam.git
|
|
48
|
+
cd okam
|
|
49
|
+
pip install -e .
|
|
50
|
+
|
|
51
|
+
# 2. Inicialize o wiki com seed pages
|
|
52
|
+
okam init
|
|
53
|
+
|
|
54
|
+
# 3. Customize o AGENTS.md com as regras do seu projeto
|
|
55
|
+
# (edite AGENTS.md com suas preferências)
|
|
56
|
+
|
|
57
|
+
# 4. Valide a conformidade
|
|
58
|
+
okam validate
|
|
59
|
+
|
|
60
|
+
# 5. Crie uma nova skill interativamente
|
|
61
|
+
okam new-skill
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
*Nota: O script legado `python knowledge/scripts/okf_manager.py` continua funcionando como um wrapper de compatibilidade.*
|
|
65
|
+
|
|
66
|
+
Para o guia completo, veja o [QUICKSTART.md](./QUICKSTART.md).
|
|
67
|
+
|
|
68
|
+
## Conceitos Core
|
|
69
|
+
|
|
70
|
+
| Conceito | O Que É | Doc |
|
|
71
|
+
|:---|:---|:---|
|
|
72
|
+
| **LLM Wiki** | Memória persistente vs RAG tradicional | [docs/concepts/llm-wiki.md](./docs/concepts/llm-wiki.md) |
|
|
73
|
+
| **OKF** | Formato padronizado de metadados para conhecimento | [docs/concepts/okf-format.md](./docs/concepts/okf-format.md) |
|
|
74
|
+
| **Deep Metadata** | Pipeline de 4 fases para extrair contexto | [docs/concepts/deep-metadata.md](./docs/concepts/deep-metadata.md) |
|
|
75
|
+
| **Guided Tours** | Padrão TOUR.md para onboarding de agentes | [docs/concepts/guided-tours.md](./docs/concepts/guided-tours.md) |
|
|
76
|
+
| **Git Hooks** | Governança automatizada via hooks pre-commit/push | [docs/concepts/git-hooks.md](./docs/concepts/git-hooks.md) |
|
|
77
|
+
|
|
78
|
+
## Estrutura do Projeto
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
okam/
|
|
82
|
+
├── .agents/
|
|
83
|
+
│ ├── rules/ # Padrões de governança
|
|
84
|
+
│ ├── skills/ # Capacidades modulares
|
|
85
|
+
│ │ ├── deep-metadata-analysis/
|
|
86
|
+
│ │ ├── knowledge-wiki/
|
|
87
|
+
│ │ └── memory-maintenance/
|
|
88
|
+
│ └── workflows/ # Pipelines de execução
|
|
89
|
+
├── hooks/ # Git hooks portáveis (POSIX sh)
|
|
90
|
+
│ ├── pre-commit # Validação OKF + detecção de segredos
|
|
91
|
+
│ ├── commit-msg # Conventional Commits
|
|
92
|
+
│ └── pre-push # Validação OKF completa
|
|
93
|
+
├── knowledge/
|
|
94
|
+
│ ├── wiki/ # Páginas de síntese (OKF)
|
|
95
|
+
│ ├── raw-sources/ # Fontes brutas
|
|
96
|
+
│ └── scripts/ # Validador OKF
|
|
97
|
+
├── templates/ # Templates reutilizáveis
|
|
98
|
+
├── docs/
|
|
99
|
+
│ ├── concepts/ # Documentação de conceitos
|
|
100
|
+
│ └── diagrams/ # Diagramas Mermaid
|
|
101
|
+
├── landing/ # Landing page
|
|
102
|
+
├── AGENTS.md # Governança central
|
|
103
|
+
├── QUICKSTART.md # Guia rápido
|
|
104
|
+
└── LICENSE # MIT
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Construído Com
|
|
108
|
+
|
|
109
|
+
- **Python** — Validador OKF (zero dependências, stdlib only)
|
|
110
|
+
- **Markdown** — Documentação e Wiki
|
|
111
|
+
- **YAML** — Metadados estruturados
|
|
112
|
+
|
|
113
|
+
## Contribuindo
|
|
114
|
+
|
|
115
|
+
1. Fork o repositório
|
|
116
|
+
2. Crie uma branch para sua feature (`git checkout -b feat/minha-feature`)
|
|
117
|
+
3. Instale os hooks de governança (`okam hooks install`)
|
|
118
|
+
4. Commit suas mudanças (`git commit -m 'feat: adiciona minha feature'`)
|
|
119
|
+
5. Push para a branch (`git push origin feat/minha-feature`)
|
|
120
|
+
6. Abra um Pull Request
|
|
121
|
+
|
|
122
|
+
## Licença
|
|
123
|
+
|
|
124
|
+
Este projeto está sob a licença MIT. Veja [LICENSE](./LICENSE) para mais detalhes.
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
<div align="center">
|
|
129
|
+
|
|
130
|
+
**⬡ Feito por devs, para devs.**
|
|
131
|
+
|
|
132
|
+
[Landing Page](./landing/index.html) · [Quick Start](./QUICKSTART.md) · [Documentação](./docs/)
|
|
133
|
+
|
|
134
|
+
</div>
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
tags:
|
|
3
|
+
- projeto
|
|
4
|
+
- okam
|
|
5
|
+
status: 🟡 Em Desenvolvimento
|
|
6
|
+
prioridade: 🔴 Alta
|
|
7
|
+
faturamento_previsto: 0
|
|
8
|
+
data_criacao: 2026-07-01
|
|
9
|
+
data_revisao: 2026-07-01
|
|
10
|
+
impacto_pareto: 20%
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Projeto: okam
|
|
14
|
+
|
|
15
|
+
## 🎯 Objetivo
|
|
16
|
+
Empacotar a infraestrutura de governança de IA existente no workspace como um template público (open-source) chamado Okam.
|
|
17
|
+
|
|
18
|
+
## 💰 Valor Estratégico (Pareto)
|
|
19
|
+
- [x] **Impacto Financeiro:** Baixo (Open-Source público, mas serve como gerador de autoridade e base para consultorias Enterprise)
|
|
20
|
+
- [x] **Esforço Estimado:** Médio
|
|
21
|
+
- [x] **Alinhamento Vida-OS:** Sim (Melhora a governança de IA em todo o workspace)
|
|
22
|
+
|
|
23
|
+
## 📝 Notas e Contexto
|
|
24
|
+
Framework de governança de IA para desenvolvedores brasileiros. Inclui AGENTS.md, Skills, Wiki OKF com validador zero-dependencies e landing page premium.
|
|
25
|
+
|
|
26
|
+
Links Úteis:
|
|
27
|
+
- [README local](file:///d:/projetos/juliano-ceconi/03_Inteligencia/okam/README.md)
|
|
28
|
+
- [QUICKSTART.md](file:///d:/projetos/juliano-ceconi/03_Inteligencia/okam/QUICKSTART.md)
|
|
29
|
+
|
|
30
|
+
## ⏭️ Próximos Passos
|
|
31
|
+
- [ ] Criar repositório GitHub público em `juliano-ceconi/okam`
|
|
32
|
+
- [ ] Publicar a primeira versão do framework
|
|
33
|
+
- [ ] Monitorar feedbacks de desenvolvedores
|
okam-0.2.0/QUICKSTART.md
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# ⚡ Quick Start — Okam em 5 Minutos
|
|
2
|
+
|
|
3
|
+
## Pré-requisitos
|
|
4
|
+
|
|
5
|
+
- Python 3.8+ (para o validador OKF)
|
|
6
|
+
- Git
|
|
7
|
+
|
|
8
|
+
## 1. Instale o CLI
|
|
9
|
+
|
|
10
|
+
Clone o repositório e instale o CLI localmente em modo editável:
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
git clone https://github.com/juliano-ceconi/okam.git
|
|
14
|
+
cd okam
|
|
15
|
+
pip install -e .
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Isso tornará o comando global `okam` disponível no seu terminal.
|
|
19
|
+
|
|
20
|
+
## 2. Inicialize o Wiki
|
|
21
|
+
|
|
22
|
+
O comando `okam init` cria a estrutura inicial do wiki e gera 3 seed pages com frontmatter OKF válido:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
okam init
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Saída esperada:
|
|
29
|
+
```
|
|
30
|
+
Inicializando base de conhecimento OKF em: .../knowledge/wiki...
|
|
31
|
+
[CRIADO] index.md
|
|
32
|
+
[CRIADO] getting-started.md
|
|
33
|
+
[CRIADO] architecture.md
|
|
34
|
+
|
|
35
|
+
✅ 3 seed page(s) criada(s) em ...
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## 3. Customize o AGENTS.md
|
|
39
|
+
|
|
40
|
+
Abra o `AGENTS.md` na raiz e ajuste as regras para o seu projeto:
|
|
41
|
+
|
|
42
|
+
- Edite o **Pipeline de Inteligência** para refletir seus workflows
|
|
43
|
+
- Ajuste as **Convenções e Regras de Ouro** para o seu time
|
|
44
|
+
- Configure as **Proibições Cruciais** conforme seu contexto
|
|
45
|
+
|
|
46
|
+
## 4. Crie Sua Primeira Skill de Forma Interativa
|
|
47
|
+
|
|
48
|
+
Você não precisa copiar templates manualmente. Use o comando interativo:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
okam new-skill
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
O CLI perguntará interativamente o nome, descrição, versão, prioridade e se você deseja criar as subpastas padrão (`scripts/`, `examples/`, `resources/`, `references/`) de apoio, gerando tudo estruturado.
|
|
55
|
+
|
|
56
|
+
## 5. Valide Tudo e Gere Índices
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
# Valida frontmatter OKF de todos os arquivos do wiki
|
|
60
|
+
okam validate
|
|
61
|
+
|
|
62
|
+
# Gera tabela com índice de metadados
|
|
63
|
+
okam index
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## 6. Instale os Git Hooks de Governança
|
|
67
|
+
|
|
68
|
+
O Okam inclui hooks que validam automaticamente antes de cada commit e push:
|
|
69
|
+
|
|
70
|
+
| Hook | O que faz |
|
|
71
|
+
|:---|:---|
|
|
72
|
+
| `pre-commit` | Valida OKF dos arquivos staged + detecta segredos vazados |
|
|
73
|
+
| `commit-msg` | Garante o formato [Conventional Commits](https://www.conventionalcommits.org/) |
|
|
74
|
+
| `pre-push` | Re-valida OKF completo antes de enviar ao remote |
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
# Instalar todos os hooks
|
|
78
|
+
okam hooks install
|
|
79
|
+
|
|
80
|
+
# Instalar sem o hook de Conventional Commits
|
|
81
|
+
okam hooks install --skip-commit-msg
|
|
82
|
+
|
|
83
|
+
# Ver status
|
|
84
|
+
okam hooks status
|
|
85
|
+
|
|
86
|
+
# Remover (restaura backups de hooks anteriores)
|
|
87
|
+
okam hooks uninstall
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
> **Nota:** Os hooks são scripts shell portáveis (POSIX `sh`) com zero dependências externas. No Windows, rodam automaticamente via Git Bash. Para bypass emergencial, use `--no-verify` (ex: `git commit --no-verify`).
|
|
91
|
+
|
|
92
|
+
## Próximos Passos
|
|
93
|
+
|
|
94
|
+
- 📖 Leia a [documentação de conceitos](./docs/concepts/)
|
|
95
|
+
- 🧩 Explore as [skills incluídas](./.agents/skills/)
|
|
96
|
+
- 📚 Adicione conhecimento ao [wiki](./knowledge/wiki/)
|
|
97
|
+
- 🏗️ Crie um [TOUR.md](./templates/tour-template.md) para seu projeto
|
|
98
|
+
- 🔒 Instale os [Git hooks de governança](#6-instale-os-git-hooks-de-governança)
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
> **Dica:** O okam CLI funciona com zero dependências externas de runtime. O script legado `python knowledge/scripts/okf_manager.py` continua totalmente operacional e atua como wrapper redirecionando comandos para manter compatibilidade.
|
okam-0.2.0/README.md
ADDED
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# ⬡ Okam
|
|
4
|
+
|
|
5
|
+
**Pare de Redescobrir. Comece a Governar.**
|
|
6
|
+
|
|
7
|
+
Framework open-source para governança de IA, memória persistente e gestão de conhecimento.
|
|
8
|
+
|
|
9
|
+
[](./LICENSE)
|
|
10
|
+
[](https://python.org)
|
|
11
|
+
[](https://github.com/juliano-ceconi/okam/pulls)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## O Que É Isso?
|
|
18
|
+
|
|
19
|
+
**Okam** é um framework que resolve um problema simples: **seus agentes de IA não têm memória.**
|
|
20
|
+
|
|
21
|
+
Toda vez que você abre uma sessão com seu copilot, ele começa do zero. Sem contexto das decisões passadas, sem governança, sem reutilização de conhecimento.
|
|
22
|
+
|
|
23
|
+
Okam resolve isso com:
|
|
24
|
+
|
|
25
|
+
- 🏛️ **Governança** — Regras claras para seus agentes (AGENTS.md + pipeline de 4 fases)
|
|
26
|
+
- 🧩 **Skills** — Capacidades modulares reutilizáveis entre projetos
|
|
27
|
+
- 📚 **Wiki de Conhecimento** — Memória persistente no formato OKF (não é RAG)
|
|
28
|
+
- 🔍 **Pipeline de Metadados** — Extrai a "alma" dos seus projetos automaticamente
|
|
29
|
+
|
|
30
|
+
## Quick Start (5 minutos)
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
# 1. Clone e instale localmente em modo de desenvolvimento
|
|
34
|
+
git clone https://github.com/juliano-ceconi/okam.git
|
|
35
|
+
cd okam
|
|
36
|
+
pip install -e .
|
|
37
|
+
|
|
38
|
+
# 2. Inicialize o wiki com seed pages
|
|
39
|
+
okam init
|
|
40
|
+
|
|
41
|
+
# 3. Customize o AGENTS.md com as regras do seu projeto
|
|
42
|
+
# (edite AGENTS.md com suas preferências)
|
|
43
|
+
|
|
44
|
+
# 4. Valide a conformidade
|
|
45
|
+
okam validate
|
|
46
|
+
|
|
47
|
+
# 5. Crie uma nova skill interativamente
|
|
48
|
+
okam new-skill
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
*Nota: O script legado `python knowledge/scripts/okf_manager.py` continua funcionando como um wrapper de compatibilidade.*
|
|
52
|
+
|
|
53
|
+
Para o guia completo, veja o [QUICKSTART.md](./QUICKSTART.md).
|
|
54
|
+
|
|
55
|
+
## Conceitos Core
|
|
56
|
+
|
|
57
|
+
| Conceito | O Que É | Doc |
|
|
58
|
+
|:---|:---|:---|
|
|
59
|
+
| **LLM Wiki** | Memória persistente vs RAG tradicional | [docs/concepts/llm-wiki.md](./docs/concepts/llm-wiki.md) |
|
|
60
|
+
| **OKF** | Formato padronizado de metadados para conhecimento | [docs/concepts/okf-format.md](./docs/concepts/okf-format.md) |
|
|
61
|
+
| **Deep Metadata** | Pipeline de 4 fases para extrair contexto | [docs/concepts/deep-metadata.md](./docs/concepts/deep-metadata.md) |
|
|
62
|
+
| **Guided Tours** | Padrão TOUR.md para onboarding de agentes | [docs/concepts/guided-tours.md](./docs/concepts/guided-tours.md) |
|
|
63
|
+
| **Git Hooks** | Governança automatizada via hooks pre-commit/push | [docs/concepts/git-hooks.md](./docs/concepts/git-hooks.md) |
|
|
64
|
+
|
|
65
|
+
## Estrutura do Projeto
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
okam/
|
|
69
|
+
├── .agents/
|
|
70
|
+
│ ├── rules/ # Padrões de governança
|
|
71
|
+
│ ├── skills/ # Capacidades modulares
|
|
72
|
+
│ │ ├── deep-metadata-analysis/
|
|
73
|
+
│ │ ├── knowledge-wiki/
|
|
74
|
+
│ │ └── memory-maintenance/
|
|
75
|
+
│ └── workflows/ # Pipelines de execução
|
|
76
|
+
├── hooks/ # Git hooks portáveis (POSIX sh)
|
|
77
|
+
│ ├── pre-commit # Validação OKF + detecção de segredos
|
|
78
|
+
│ ├── commit-msg # Conventional Commits
|
|
79
|
+
│ └── pre-push # Validação OKF completa
|
|
80
|
+
├── knowledge/
|
|
81
|
+
│ ├── wiki/ # Páginas de síntese (OKF)
|
|
82
|
+
│ ├── raw-sources/ # Fontes brutas
|
|
83
|
+
│ └── scripts/ # Validador OKF
|
|
84
|
+
├── templates/ # Templates reutilizáveis
|
|
85
|
+
├── docs/
|
|
86
|
+
│ ├── concepts/ # Documentação de conceitos
|
|
87
|
+
│ └── diagrams/ # Diagramas Mermaid
|
|
88
|
+
├── landing/ # Landing page
|
|
89
|
+
├── AGENTS.md # Governança central
|
|
90
|
+
├── QUICKSTART.md # Guia rápido
|
|
91
|
+
└── LICENSE # MIT
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Construído Com
|
|
95
|
+
|
|
96
|
+
- **Python** — Validador OKF (zero dependências, stdlib only)
|
|
97
|
+
- **Markdown** — Documentação e Wiki
|
|
98
|
+
- **YAML** — Metadados estruturados
|
|
99
|
+
|
|
100
|
+
## Contribuindo
|
|
101
|
+
|
|
102
|
+
1. Fork o repositório
|
|
103
|
+
2. Crie uma branch para sua feature (`git checkout -b feat/minha-feature`)
|
|
104
|
+
3. Instale os hooks de governança (`okam hooks install`)
|
|
105
|
+
4. Commit suas mudanças (`git commit -m 'feat: adiciona minha feature'`)
|
|
106
|
+
5. Push para a branch (`git push origin feat/minha-feature`)
|
|
107
|
+
6. Abra um Pull Request
|
|
108
|
+
|
|
109
|
+
## Licença
|
|
110
|
+
|
|
111
|
+
Este projeto está sob a licença MIT. Veja [LICENSE](./LICENSE) para mais detalhes.
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
<div align="center">
|
|
116
|
+
|
|
117
|
+
**⬡ Feito por devs, para devs.**
|
|
118
|
+
|
|
119
|
+
[Landing Page](./landing/index.html) · [Quick Start](./QUICKSTART.md) · [Documentação](./docs/)
|
|
120
|
+
|
|
121
|
+
</div>
|