-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathllms.txt
More file actions
60 lines (40 loc) · 4.12 KB
/
Copy pathllms.txt
File metadata and controls
60 lines (40 loc) · 4.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# OKF Harness
> OKF Harness is an agent-first, local-first, terminal-native setup, runtime, and agent guidance package for maintaining OKF-compatible LLM Wikis through supported agents.
OKF Harness helps a person keep source material, synthesized markdown knowledge, citations, workspace checks, search, bounded reads, and graph reports in one local workspace.
Run setup once:
```bash
curl -fsSL https://okf-harness.dev/install.sh | sh
```
Windows PowerShell:
```powershell
irm https://okf-harness.dev/install.ps1 | iex
```
Already have Node.js 22 or newer?
```bash
npx @okf-harness/setup@latest
```
Setup installs one unified `okf-harness` entrypoint in each selected agent integration. Workspaces run their pinned runtime on demand instead of using a global runtime.
OKF Harness is local-first, not air-gapped: workspace files stay on the person's machine, but the first use of each newly pinned runtime version fetches that runtime once from npm.
Advanced direct CLI use is documented in the CLI reference.
OKF Harness is independent. It builds on Andrej Karpathy's LLM Wiki pattern and Google's Open Knowledge Format, but it is not affiliated with or endorsed by Andrej Karpathy or Google. It is not an official OKF implementation, standalone knowledge-base app, Obsidian plugin, cloud sync service, vector database, or private agent runtime.
## Core Context
- [Full LLM context](https://raw.githubusercontent.com/pumblus/okf-harness/main/llms-full.txt): generated context bundle from the public README, terminology, workflows, CLI reference, roadmap, and package READMEs.
- [Project README](https://raw.githubusercontent.com/pumblus/okf-harness/main/README.md): product overview, quick start, workflow sketch, docs, development commands, and acknowledgements.
- [Product terminology](https://raw.githubusercontent.com/pumblus/okf-harness/main/CONTEXT.md): glossary for OKF Harness, workspaces, source material, ingest, query, search, read, graph, and agent guidance.
- [User workflows](https://raw.githubusercontent.com/pumblus/okf-harness/main/docs/WORKFLOWS.md): supported-agent workflows for setup, source registration, ingest, answer, check, graph, and adapter repair.
- [CLI reference](https://raw.githubusercontent.com/pumblus/okf-harness/main/docs/CLI.md): `okfh` command contract, JSON envelope, workspace rules, and command options.
## Packages
- [@okf-harness/cli](https://www.npmjs.com/package/@okf-harness/cli): pinned workspace runtime package exposing the `okfh` and `okf-harness` binaries.
- [@okf-harness/core](https://www.npmjs.com/package/@okf-harness/core): OKF parsing, config, manifest, path safety, lint, search, graph, and source handling.
- [@okf-harness/agent-pack](https://www.npmjs.com/package/@okf-harness/agent-pack): Claude Code and Codex adapter renderers and shared skill templates.
- [@okf-harness/setup](https://www.npmjs.com/package/@okf-harness/setup): recommended setup and pinned-runtime launcher package for native agent integrations.
- [@pumblus/okf-harness](https://www.npmjs.com/package/@pumblus/okf-harness): native integration package for Pi, OpenCode, and OpenClaw.
## Project Docs
- [Public roadmap](https://raw.githubusercontent.com/pumblus/okf-harness/main/docs/ROADMAP.md): current scope, demand-ranked ideas, and constraints for future product surfaces.
- [Example workspace](https://github.com/pumblus/okf-harness/tree/main/examples/ai-research-workspace): small OKF Harness workspace with sample wiki content.
- [Contributing](https://raw.githubusercontent.com/pumblus/okf-harness/main/CONTRIBUTING.md): contribution boundaries, development setup, and verification commands.
- [Security](https://raw.githubusercontent.com/pumblus/okf-harness/main/SECURITY.md): local data boundaries, out-of-scope surfaces, and reporting contact.
## Optional
- [Chinese README](https://raw.githubusercontent.com/pumblus/okf-harness/main/README.zh-CN.md): Chinese project overview and quick start.
- [Chinese workflows](https://raw.githubusercontent.com/pumblus/okf-harness/main/docs/zh-CN/WORKFLOWS.md): Chinese workflow guide.
- [Chinese CLI reference](https://raw.githubusercontent.com/pumblus/okf-harness/main/docs/zh-CN/CLI.md): Chinese command reference.