OKF Atlas
Bundle OKF 0.1 · 649 conceitos · Fengzdadi/okf-atlas
Open source Repository Open in the app JSON README (API)
About
# OKF Atlas
Generated Stage 1 bundle for `okf-atlas`.
How to use this bundle (for agents and readers): `modules/` pages
mirror source files with `# Imports`, `# Exports`, `# Imported by`
(reverse dependencies), and `# Tests` links — use them to locate
code before grepping. If `wiki/` exists, pick ONE page by question
type — `wiki/change-guide.md` for "where do I change X",
`wiki/core-flows.md` for "how does X work end to end",
`wiki/architecture.md` for structure and design rationale,
`wiki/entrypoints.md` for how to run or invoke the project — and
read source directly for exact behavioral details. Do not
hand-edit generated files; to correct and keep a page, edit it and
set `okf_atlas.locked: true` so regeneration preserves it.
## Module
- [CLAUDE.md](modules/claude_md.md) - Static module extracted from CLAUDE.md.
- [guide.md](modules/docs/guide_md.md) - Static module extracted from docs/guide.md.
- [guide.zh-CN.md](modules/docs/guide.zh-cn_md.md) - Static module extracted from do
Details
- Kind
- OKF bundles
- Topic
- Developer tools
- Publisher
- fengzdadi
- Origin
- okf_github
- Category
- dados
- Version
- 0.1
- Last push
- 2026-07-05T20:49:13Z
- Repository state
- ativo
- Language
- TypeScript
- License
- MIT
- Added
- 2026-09-09 19:04:11
- Updated
- 2026-09-09 19:04:11
- Origin id
Fengzdadi/okf-atlas:docs/okf/index.md
README
# OKF Atlas **A machine-readable knowledge layer for your repository, built for coding agents.** One command turns your repo into a browsable index of every file, symbol, dependency, and test — plus four LLM-drafted wiki pages (architecture, entry points, core flows, change guide) that give agents and new contributors instant orientation. Bundles follow the [OKF spec](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md). ## Quick start ```bash git clone https://github.com/Fengzdadi/okf-atlas && cd okf-atlas pnpm install && pnpm build ``` **Index your repo — no API key, no LLM, seconds:** ```bash pnpm exec okf-atlas generate /path/to/your/repo --stage1-only ``` Open `/path/to/your/repo/docs/okf/index.md` and browse: per-file pages with import graphs and reverse dependencies, one page per exported symbol, per database table, per CLI entry point. **Add the wiki pages** (the part worth reading first) — no API key needed if you have Claude Code or Codex installed. Just run `pnpm exec okf-atlas wiki /path/to/your/repo`: Atlas detects the subscription CLIs on your machine and asks which one to draft through. To script it instead: ```bash export OKF_ATLAS_LLM_PROVIDER=command export OKF_ATLAS_LLM_COMMAND="$PWD/scripts/claude-code-provider.mjs" # or codex-provider.mjs pnpm exec okf-atlas wiki /path/to/your/repo # 4 calls, a few minutes ``` (Any OpenAI-compatible API key works too: `cp .env.example .env`, fill it in, `set -a; source .env; set +a`.) **Point agents at it** — one line in your repo's `CLAUDE.md`/`AGENTS.md`: > Consult `docs/okf/index.md` to navigate this repo. That's it. Reruns are incremental and byte-deterministic; commit `docs/okf/` so your team and their agents get it for free. ## What you get ``` docs/okf/ ├── wiki/ # architecture, entrypoints, core-flows, change-guide ├── modules/<path>.md # per file: imports, exports, imported-by, tests ├── apis/ data/ commands/ migrations/ external/ references/ tests/ └── index.md # everything, grouped by type ``` ## Highlights - **Deterministic core** — everything except `wiki/` is extracted statically (TS/JS via the compiler API, Python line-level, SQL, OpenAPI, ADRs). Byte-identical reruns, CI-enforceable with `generate --stage1-only && git diff --exit-code`. - **Cost safety** — `--estimate` projects LLM calls and payload before you spend; `--max-calls` hard-caps; failures isolate per item and retry next run; every run prints actual usage. - **Bring your API key or your subscription** — providers are pluggable executables: OpenAI-compatible endpoints, Claude Code (Claude plan), or Codex CLI (ChatGPT plan). - **Tunable per repo** — `.okf-atlas.yaml` scopes discovery, retypes pages by glob, thresholds reference promotion, budgets the wiki. - **Tooling-friendly** — every command speaks `--format json`; `lint --mode producer` validates any bundle in seconds. Full documentation: **[docs/guide.md](docs/guide.md)** · [中文指南](docs/guide.zh-CN.md) · design contract: [SPEC-INTERNAL.md](SPEC-INTERNAL.md) · [ROADMAP.md](ROADMAP.md) ## Status v0.1, pre-npm (`npx okf-atlas` coming). Validated end to end on external multi-package repositories; this repo indexes itself — `docs/okf/` here is Atlas's own output. MIT licensed. 中文说明见 [README.zh-CN.md](README.zh-CN.md).