okf-gem

Everything OKF,
in one gem

Todo o OKF,
em uma gem

Stop re-explaining your project to every agent. okf-gem turns your knowledge into a markdown knowledge graph: one durable home your team and your agents create, keep fresh, and read from. Open source, 100% local.

Pare de reexplicar o seu projeto a cada agente. okf-gem transforma o seu conhecimento em um grafo de conhecimento em markdown: um lar durável que o seu time e os seus agentes criam, mantêm em dia e leem. Open source, 100% local.

Gem version Downloads

What is OKF, in a nutshell

O que é OKF, em resumo

open · vendor-neutral · Markdown + YAMLaberto · neutro · Markdown + YAML

OKF: an open, vendor-neutral format for project knowledge, from Google Cloud (2026). A bundle is a directory of Markdown + YAML that people and agents read from one source. One file, one concept. The links are the graph. Just .md in your repo, versioned with the code.

OKF: um formato aberto e neutro para o conhecimento do projeto, do Google Cloud (2026). Um bundle é um diretório de Markdown + YAML que pessoas e agentes leem da mesma fonte. Um arquivo, um conceito. Os links são o grafo. É só .md no seu repositório, versionado junto com o código.

an entire bundle, nothing hiddenum bundle inteiro, sem nada escondido
docs/
├── index.md # the map: what lives here, one line per entry# o mapa: o que vive aqui, uma linha por entrada
├── log.md # dated history of what changed in the knowledge# histórico datado do que mudou no conhecimento
├── services/
│ ├── index.md
│ └── billing.md # one concept = one Markdown file# um conceito = um arquivo Markdown
├── tables/
│ ├── orders.md
│ └── customers.md
└── decisions/
└── payment-id-dedup.md
a bundle is a directory
um bundle é um diretório
docs/tables/orders.md
---
type: BigQuery Table
title: Orders
description: One row per confirmed order.Uma linha por pedido confirmado.
tags: [billing, core]
---
Joined with Faz join com [customers](/tables/customers.md)
for revenue reports.nos relatórios de receita.
The 2023 dedup incident is whyO incidente de dedup de 2023 é
payment_id is the key.o motivo de a chave ser payment_id.
one file, one concept. the link is an edge.
um arquivo, um conceito. o link é uma aresta.

Not a knowledge base. A standard for your project's knowledge.

Não é uma base de conhecimento. Um padrão para o conhecimento do seu projeto.

create · maintain · consumecriar · manter · consumir

okf-gem is not a system with a database or access controls. It is a local, standardized way to create, maintain, and consume your project's knowledge, with your agent, inside Claude Code, Codex, or any agent. What it takes off your plate:

okf-gem não é um sistema com banco de dados ou controle de acesso. É uma forma local e padronizada de criar, manter e consumir o conhecimento do seu projeto, com o seu agente, dentro do Claude Code, Codex ou qualquer agente. O que ele tira das suas costas:

📐 the format decideso formato decide

No standard to invent

Nenhum padrão para inventar

OKF already decides how knowledge is structured, so you write what matters instead of designing a doc system or arguing about folders.

O OKF já decide como o conhecimento é estruturado, então você escreve o que importa em vez de projetar um sistema de docs ou discutir sobre pastas.

🔗 it connects itselfele se conecta sozinho

No index to wire up

Nenhum índice para montar

Connections form from the links you already write. You never build or maintain an index, and nothing rots because it fell off a table of contents.

As conexões surgem dos links que você já escreve. Você nunca monta nem mantém um índice, e nada apodrece por ter caído de um sumário.

🔄 it stays freshfica sempre em dia

No upkeep to remember

Nenhuma manutenção para lembrar

The bundle is checked as you work, and with the Claude plugin it is kept in sync as the code changes. Curation stops being a chore you forget.

O bundle é checado enquanto você trabalha, e com o plugin do Claude ele fica em dia conforme o código muda. Curadoria deixa de ser uma tarefa que você esquece.

Why it pays off

Por que compensa

The return is simple: less rework, and knowledge that compounds instead of evaporating between sessions and people.

O retorno é simples: menos retrabalho, e conhecimento que se acumula em vez de evaporar entre sessões e pessoas.

Agents stop re-deriving contextAgentes param de re-derivar contextoEvery session starts from the same durable source instead of re-reading the codebase. Less time, fewer tokens, more consistent answers.Cada sessão começa da mesma fonte durável em vez de reler a base de código. Menos tempo, menos tokens, respostas mais consistentes.
Your knowledge stays yoursO seu conhecimento continua seu100% local. No account, no telemetry, nothing uploaded. The most sensitive artifact a team owns never leaves the machine.100% local. Sem conta, sem telemetria, nada enviado. O artefato mais sensível de um time nunca sai da máquina.
Onboarding for people and agentsOnboarding para pessoas e agentesNew teammates and new agents read the same file. The reasoning behind a service or a metric is written down, not trapped in someone's head.Novas pessoas e novos agentes leem o mesmo arquivo. O porquê de um serviço ou de uma métrica fica escrito, não preso na cabeça de alguém.
Portable, no lock-inPortátil, sem lock-inPlain Markdown and an open, vendor-neutral format. It moves with your repo and works with any agent.Markdown puro e um formato aberto e neutro. Anda junto com o seu repositório e funciona com qualquer agente.
demo.okfgem.com

See it for yourself

Veja você mesmo

You have read what it does. Now open it and search real knowledge yourself: ask a question, watch the answer surface from across four live bundles at once, and click any concept to read the reasoning behind it, diagrams and all. Then imagine it on your own project.

Você já leu o que ela faz. Agora abra e busque em conhecimento real: faça uma pergunta, veja a resposta surgir de quatro bundles ao vivo de uma vez, e clique em qualquer conceito para ler o raciocínio por trás dele, com diagramas e tudo. Depois, imagine isso no seu próprio projeto.

Three cores, one gem

Três núcleos, uma gem

author · curate · consumecriar · curar · consumir

The knowledge lives as plain Markdown in your repo, in the open OKF format (Google Cloud, 2026). Three cores turn it into something your agents and your team actually use:

O conhecimento vive como Markdown no seu repositório, no formato aberto OKF (Google Cloud, 2026). Três núcleos o transformam em algo que os seus agentes e o seu time realmente usam:

🧠 The brainO cérebro

Agent Skill

Agent Skill

Stop re-explaining the same decisions every session. Your agent writes down the why behind a choice, the part it can never recover from the code, and reads back only what a question needs instead of re-scanning the whole project. You stay the editor, and the reasoning outlives whoever wrote it.

Pare de reexplicar as mesmas decisões a cada sessão. Seu agente registra o porquê de uma escolha, a parte que ele nunca recupera do código, e lê de volta só o que a pergunta precisa, em vez de varrer o projeto inteiro. Você continua o editor, e o raciocínio sobrevive a quem o escreveu.

okf skill .claude
💪 The muscleO músculo

CLI & Library

CLI & Biblioteca

Deterministic checks the agent and your CI can trust: is the bundle valid, is it well curated, what does it actually say. Gate a merge on them, or call them as Ruby objects in your own code. And search answers a question from a fraction of the bundle, so context stays lean.

Checagens determinísticas em que o agente e a sua CI confiam: o bundle está válido, está bem curado, o que ele realmente diz. Bloqueie um merge com elas, ou use como objetos Ruby no seu código. E a busca responde uma pergunta a partir de uma fração do bundle, então o contexto fica enxuto.

okf validate · lint · search
📊 The dashboardO painel

Graph

Grafo

The same files your agents read become a page your whole team can browse and search. One search reaches across every bundle you own, from a phone or a desktop. Serve it live, or export one static file that hosts anywhere.

Os mesmos arquivos que os seus agentes leem viram uma página que todo o time navega e busca. Uma busca alcança todos os bundles que você tem, do celular ao desktop. Sirva ao vivo, ou exporte um arquivo estático que hospeda em qualquer lugar.

okf server · render · registry

Try it in four steps

Experimente em quatro passos

from zero to your first bundledo zero ao seu primeiro bundle
1

Get the okf command

Instale o comando okf

Two ways in; either one puts okf on your PATH.

Dois caminhos; qualquer um coloca o okf no seu PATH.

With RubyCom Ruby gem install okf
No Ruby? DockerSem Ruby? Docker curl -fsSL https://docker.okfgem.com/install.sh | sh
2

Install the skill

Instale a skill

Teach your agent the format. Claude Code, or any other agent.

Ensine o formato ao seu agente. Claude Code, ou qualquer outro.

okf skill .claude # or: okf skill .agents
3

Start an agent session

Abra uma sessão do agente

Open your agent where your project lives.

Abra o agente onde o seu projeto está.

claude
4

Make your first bundle

Crie o seu primeiro bundle

Two ways in, by what you already have. Docs keep every word; code gets written up for you.

Dois caminhos, conforme o que você já tem. Os docs mantêm cada palavra; o código é escrito para você.

Have docs? MigrateTem docs? Migre /okf migrate <path-to-your-docs>
Only code? ProduceSó código? Produza /okf produce based on <path-to-your-code>
Once you have a bundle, run /okf maintain in your agent session to keep it in sync as the code changes, or install the Claude plugin so a Stop hook does it for you. Register it once (okf registry set <folder>) and every verb reaches it as @slug from anywhere, with a bare okf server opening everything you keep. To share it, okf render <folder> writes the same page as one static file you can host. Quando tiver um bundle, rode /okf maintain na sessão do agente para mantê-lo em dia conforme o código muda, ou instale o plugin do Claude para um Stop hook fazer isso por você. Registre-o uma vez (okf registry set <pasta>) e todo verbo o alcança como @slug de qualquer lugar, com um okf server sem argumentos abrindo tudo o que você mantém. Para compartilhar, o okf render <pasta> escreve a mesma página como um arquivo estático que você hospeda.

Go deeper

Explore mais