Docs · install · CLI · stack

MCP Ready

Your LLM can call KBatch tools for geometric path analysis, efficiency metrics, and multi-layout shadows. See the DOJO · full list in docs/MCP.md · mcp/manifest.json.

kbatchDict.mcp("kbatch_analyze", { text: "type once", level: "sentence" })
kbatchDict.mcp("kbatch_path_rank", { text: "ergonomic", limit: 6 })
kbatchDict.colossus(["the", "quantum", "flow"])

Install · get kb on PATH

User install lands in ~/.local/bin. After install: kb version · kb doctor · kb serve.

# recommended — full tree + SPA
git clone https://github.com/qbitOS/ugrad-kbatch.git
cd ugrad-kbatch   # or: KBatch-dictionary
make install      # → ~/.local/bin/kb
# or: ./install.sh

# PATH (zsh)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc && source ~/.zshrc

kb doctor
kb serve          # http://127.0.0.1:8765
kb open           # serve + browser
kb update         # registers + quantum gutter vendor + stamp

# Go 1.22+ · https://go.dev/dl/  or  brew install go
git clone https://github.com/qbitOS/ugrad-kbatch.git && cd ugrad-kbatch
go install ./cmd/kb

export PATH="$(go env GOPATH)/bin:$PATH"
export KBATCH_ROOT="$(pwd)"   # points launcher at full tree

kb version
kb serve

# from checkout
brew install --build-from-source ./Formula/kbatch.rb
# depends on node (+ python recommended)

kb doctor
kb serve
kb update

npm install
npm link                 # kb + kbatch on PATH
# or: npm install -g .

kb version
kb serve
npm run kb:upgrade

# https://docs.astral.sh/uv/
uv tool install --from . ugrad-kbatch
# or editable:
uv pip install -e .

kb serve
python -m kbatch_cli doctor

cargo install --path rust-cli --force
export KBATCH_ROOT="$(pwd)"

kb version
kb update

One binary · many planes

kb                 # help
kb serve           # SPA :8765
kb open            # serve + browser
kb doctor          # toolchain check
kb version

kb update          # registers + gutter + stamp
kb upgrade         # + minor version set
kb deep            # deep register mine
kb stamp
kb registers --fetch

# open /#terminal or panel “Terminal · Freya / GY mesh”
kb> help
kb> mesh lab-room
kb> analyze type once
kb> gutter def hello():
kb> update | upgrade
kb> nfc share

Everything on the site + in kb

Quantum gutter fold-through

Symbols n: +1: -n: +0: 0: -1: +n: +2: -0: +3: 1: classify every line (code + speech). Vendored under vendor/gluelam/; loaded before remote mueee.

kb update                 # refresh vendor modules
# browser console:
kbatchDict.corpus.gutter("type once")
kbatchDict.corpus.ensureGutter()

Mesh · multi-device knowledge

No single device is the only gate. Heavy Shadow Live ticks publish on kbatch-mesh · gy-stream · freya-signal.

kb serve
# tab A + tab B → Join mesh · Publish knowledge
# deep link:  ?mesh=lab-room
# NFC (Android Chrome HTTPS): nfc share | nfc scan

See MESH-ACCESS.md · Freya freya.qbitos.ai · GY site.

Environment

export KBATCH_ROOT=/path/to/ugrad-kbatch
export KBATCH_PORT=8765
export KBATCH_HOST=127.0.0.1
export PATH="$HOME/.local/bin:$(go env GOPATH)/bin:$PATH"

Markdown docs tree

• INSTALL.md — full install matrix
• KB-UPDATE.md — update / upgrade set
• MESH-ACCESS.md — PWA · cache · mesh · NFC
• ECOSYSTEM-MAP.md — glulam stack
• WHERE-IT-LIVES.md — DNS · CF · hosts
• HOSTING.md · DNS.md · RESEARCH-LAYER.md