{"id":51051064,"url":"https://github.com/lloydrichards/edu_effect-okf","last_synced_at":"2026-06-22T17:01:09.360Z","repository":{"id":366211681,"uuid":"1274342567","full_name":"lloydrichards/edu_effect-okf","owner":"lloydrichards","description":"Use Effect v4 (beta) to create CLI tools and services that can parse, validate, ingest, query, and reason over OKF bundles, integrated with RAG (Retrieval-Augmented Generation) via ChromaDB","archived":false,"fork":false,"pushed_at":"2026-06-20T18:39:36.000Z","size":130,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-20T20:12:01.042Z","etag":null,"topics":["effect-ts","okf","rag"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lloydrichards.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"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":"2026-06-19T12:15:55.000Z","updated_at":"2026-06-20T18:39:39.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/lloydrichards/edu_effect-okf","commit_stats":null,"previous_names":["lloydrichards/edu_effect-okf"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/lloydrichards/edu_effect-okf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lloydrichards%2Fedu_effect-okf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lloydrichards%2Fedu_effect-okf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lloydrichards%2Fedu_effect-okf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lloydrichards%2Fedu_effect-okf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lloydrichards","download_url":"https://codeload.github.com/lloydrichards/edu_effect-okf/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lloydrichards%2Fedu_effect-okf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34657902,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-22T02:00:06.391Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["effect-ts","okf","rag"],"created_at":"2026-06-22T17:01:08.690Z","updated_at":"2026-06-22T17:01:09.354Z","avatar_url":"https://github.com/lloydrichards.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# edu_effect-okf\n\nExploring Google's [Open Knowledge Format (OKF)](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) with Effect v4 and RAG.\n\n## What is OKF?\n\nOpen Knowledge Format is a vendor-neutral specification from Google for representing knowledge as plain markdown files with YAML frontmatter, organized in directory hierarchies (\"bundles\"). It is human-readable, version-controllable, and designed for both agents and people to produce and consume.\n\n- [OKF Spec (v0.1)](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md)\n- [Google Knowledge Catalog repo](https://github.com/GoogleCloudPlatform/knowledge-catalog)\n\n## What this repo explores\n\nThis is a learning and experimentation repo with two goals:\n\n1. **Learn OKF concepts** -- understand the spec, bundle structure, concept documents, cross-linking, and how knowledge bundles are produced/consumed.\n2. **Build Effect-based tooling** -- use Effect v4 (beta) to create CLI tools and services that can parse, validate, ingest, query, and reason over OKF bundles, integrated with RAG (Retrieval-Augmented Generation) via ChromaDB.\n\n## Architecture\n\n```\nedu_effect-okf/\n├── apps/\n│   ├── cli/              # Main tool for interacting with OKF bundles\n│   └── server/           # Example HTTP/RPC server with AI chat (experimental)\n├── packages/\n│   ├── ai/              # Agentic loop: LLM integration, toolkits, streaming chat\n│   ├── rag/             # RAG pipeline: chunking, embedding, ChromaDB storage/retrieval\n│   ├── domain/          # Shared schemas: API, Chat protocol, Chunk types, OKF types (planned)\n│   └── config-typescript/  # Shared tsconfig base\n```\n\n| Workspace | Purpose |\n|-----------|---------|\n| `apps/cli` | CLI for OKF operations (skeleton -- commands TBD) |\n| `apps/server` | Example AI chat server over RPC (experimental) |\n| `packages/ai` | Anthropic LLM, toolkits (think, datetime, rag), agentic loop |\n| `packages/rag` | Chunking (byte/token), ChromaDB client, ingest/retrieve |\n| `packages/domain` | Effect Schema definitions shared across packages |\n\n## Getting Started\n\n### Prerequisites\n\n- [Bun](https://bun.sh/) 1.2+\n- Docker (for ChromaDB)\n- `ANTHROPIC_API_KEY` environment variable\n\n### Install\n\n```bash\nbun install\n```\n\n### Development\n\n```bash\nbun dev              # Start all apps\nbun dev --filter=cli # Start CLI only\nbun run build        # Build all\nbun lint             # Lint with Biome\nbun format           # Format with Biome\nbun test             # Run all tests (Vitest)\n```\n\n## Infrastructure\n\n### Local ChromaDB (Docker)\n\nFor local dev, run the ChromaDB container and point the server at it:\n\n```bash\n# Start the ChromaDB service only\ndocker run -d --name edu_chroma -p 8000:8000 chromadb/chroma\n\n# In another shell, run with ChromaDB env vars\nCHROMA_HOST=localhost CHROMA_PORT=8000 bun dev --filter=server\n```\n\nChromaDB will be available at `http://localhost:8000`.\n\n## References\n\n- [OKF Spec v0.1](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md)\n- [Google Knowledge Catalog](https://github.com/GoogleCloudPlatform/knowledge-catalog)\n- [Effect (v4 beta)](https://github.com/Effect-TS/effect-smol)\n- [Chonkie (chunking library)](https://github.com/chonkie-inc/chonkie)\n- [edu_effect-rag-builder (predecessor)](https://github.com/lloydrichards/edu_effect-rag-builder)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flloydrichards%2Fedu_effect-okf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flloydrichards%2Fedu_effect-okf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flloydrichards%2Fedu_effect-okf/lists"}