Skip to content
KnowFlow logoKnowFlow

Quickstart

Requirements: Node.js 18+, Python 3.10+, Bash, and curl.

Install from npm. No global install needed for a one-off: npx @jerryjiao/knowflow@latest <command>.

1. Install

Section titled “1. Install”
Terminal window
npm install -g @jerryjiao/knowflow

2. Create a project and capture a note

Section titled “2. Create a project and capture a note”
Terminal window
knowflow init my-wiki
cd my-wiki
knowflow ingest "Karpathy's LLM Wiki essay: an agent curates saved links into durable, linked wiki pages." --source text

The note now exists under raw/web/. It has not been converted into a wiki page — capture is deterministic and never writes wiki pages.

3. Synthesize with any coding agent

Section titled “3. Synthesize with any coding agent”

This is where KnowFlow’s mainline story kicks in: the CLI captures, your coding agent synthesizes. knowflow init materialized the shared contract into this workspace — docs/agents/synthesize.md (plus an AGENTS.md pointer section and a CLAUDE.md shim, so any agent finds it zero-config). ZCode, Codex CLI, Claude Code, OpenCode — any agent that can read and write files — follows that one contract. Paste this into your agent:

Synthesize my KnowFlow wiki following the contract at
docs/agents/synthesize.md in this workspace.


1. Run `knowflow compose --list` to see which raw files have no wiki page yet.
2. Synthesize each listed file: a `status: pending` source page plus minimal
   entity pages, written straight into their final wiki/ directories.
3. Run `knowflow health` and `knowflow check`, then fix anything in the pages
   you just created. Never run `knowflow fix` without --dry-run.

(The upstream master is maintained at the same path in the knowflow repository: https://github.com/jerryjiao/knowflow/blob/main/docs/agents/synthesize.md )

For the note above, the agent drafts two pending pages.

wiki/sources/karpathy-llm-wiki.md:

---
type: source
title: Karpathy's LLM Wiki essay
created: 2026-09-02
created_from: raw/web/2026-09-02-1030-note.md
status: pending
---


# Karpathy's LLM Wiki essay


## 一句话总结


Curating saved links into durable, linked wiki pages beats hoarding a read-later pile.


## 核心要点


- An agent curates saved links into durable, linked wiki pages. (EXTRACTED)
- Compiled knowledge beats re-searching the raw pile for every question. (EXTRACTED)
- The raw pile stays as the source material while the wiki becomes the working layer — inferred from the "curates … into" phrasing. (INFERRED)


## 提取的实体


- [[entities/karpathy]] — author of the essay; plays the curator role.


## 提取的概念


- LLM Wiki — the essay's method of compiling saves into linked pages. No wikilink yet: concept pages are synthesized only when you explicitly ask.

wiki/entities/karpathy.md:

---
type: entity
title: Karpathy
created: 2026-09-02
created_from: raw/web/2026-09-02-1030-note.md
status: pending
---


# Karpathy


## 基本信息


- **类型**: 人
- **别名/英文名**: Andrej Karpathy
- **所属领域**: AI research and engineering
- **关键数据**: 无


## 核心要点


- Wrote the LLM Wiki essay this source note summarizes. (EXTRACTED)
- Frames an LLM agent as a full-time curator of the wiki — extrapolated from the essay summary. (INFERRED)


## 关联内容


- 来源: [[sources/karpathy-llm-wiki]]

Things worth noticing in these pages:

  • Section headings are canonical Chinese strings — the page anatomy is fixed, while your content stays in your own language.
  • Every key point ends with exactly one (EXTRACTED) or (INFERRED) marker, so you can see what came from the source versus what the agent inferred.
  • created_from points back at the raw file, and status: pending means “awaiting your review”.
  • Links are root-relative and bare: [[entities/karpathy]], never [[Karpathy]].

4. Review

Section titled “4. Review”

knowflow status lists every page awaiting you:

Terminal window
$ knowflow status
  📊 KnowFlow 状态概览
  ...
  待审页面（pending）
    wiki/entities/karpathy.md
    wiki/sources/karpathy-llm-wiki.md


  共 2 页待审

Approving a page is one word: open it, read it, change pending to reviewed in the frontmatter. Rejecting is equally simple — delete the file. Want a machine gate before your own read? knowflow check validates the eight-condition page anatomy.

5. Validate and build the graph

Section titled “5. Validate and build the graph”
Terminal window
knowflow health
knowflow graph --no-open
  • knowflow health checks broken links, undersized files, and orphans. Pending pages are exempt from the orphan rule — an unreviewed page with no inbound links is normal — and knowflow fix never touches them.
  • graph/graph.html — the interactive graph viewer (loads vis-network from a CDN on first open). The graph build skipped these pages while they were pending; after your review, both pages and the link between them appear.
  • graph/graph.json — graph data you can feed to other tools

The KnowFlow interactive knowledge graph

Where to go next

Section titled “Where to go next”