Old Norse goddess of wisdom and oaths — "she who knows."
Single-binary Go CLI cheat-sheet — invokable as vor or the legacy alias cs. 814 cheatsheets + 737 deep-dive pages across 63 categories (including a 55-sheet ramp-up/ ELI5 curriculum). Built-in calculator, subnet calculator, fuzzy search, interactive TUI, REST API, shell completions. Every sheet self-contained — paste-ready commands with expected output, every concept defined in-sheet, every cross-reference resolved.
Certification coverage: CCNP DC, CCNP Enterprise, CCIE EI/SP/Security/Automation, JNCIE-SP, JNCIE-SEC, CompTIA Linux+, CISSP, C|RAGE.
git clone git@github.com:bellistech/vor.git
cd vor
make install # builds vor → /usr/local/bin/vor
# symlinks cs → vor (backward-compat)
# auto-installs bash/zsh/fish tab-completion for bothmake install writes shell tab-completion scripts to the standard system locations (Homebrew on macOS, /etc on Linux, ~/.config/fish for fish). After install, restart your shell or source your rc — vor <TAB> and cs <TAB> both complete topics, categories, flags.
If your environment isn't writable, fall back to manual:
echo 'eval "$(vor --completions bash)"' >> ~/.bashrc
echo 'eval "$(vor --completions zsh)"' >> ~/.zshrc
echo 'vor --completions fish | source' >> ~/.config/fish/config.fishcs # list all topics by category
cs lvm # show LVM cheatsheet
cs storage # list sheets in a category
cs lvm extend # show only the "extend" section
cs -s lvextend # search across all sheets
cs -l # list with descriptions
cs -i # interactive TUI
cs --add mysheet.md # custom cheatsheet
cs --edit lvm # override sheet in $EDITOR
cs --random # random cheatsheet
cs --count # per-category statistics + bar chart
cs -so help # Stack Overflow lookup — bonus opt-in (see below)Fuzzy match: cs kube → kubernetes. cs lv → lvm.
cs -d bgp # peering formula, convergence, dampening decay
cs -d tcp # window math, congestion control, RTT estimation
cs -d postgresql # query planner cost model, B-tree splits, MVCC
cs -d kubernetes # scheduler scoring, Raft consensus, HPA formula
cs -d tls # handshake state machine, ECDHE math, cipher suites
cs -d bgp --prereqs # prerequisites for a detail page737 detail pages — formulas, worked examples, complexity analysis, engineering tradeoffs.
cs --related bgp # ospf, is-is, mpls, tcp, subnetting
cs --related docker # podman, kubernetes, containerd
cs compare docker podman # feature comparison table
cs compare ext4 xfs # filesystem comparisoncs learn networking # prerequisite-ordered topic list
cs learn databases # sql → postgresql → redis progression
cs --prereqs bgp # show prerequisites for a deep-dive page
cs ramp-up # 55 ELI5 ramp-up sheets — one per topicThe ramp-up category is narrative-shaped — one comprehensive ELI5-voiced sheet per topic. Vocabulary tables defining every term, ASCII diagrams, paste-and-runnable shell with literal expected output, broken-then-fixed confusion pairs. Designed for absolute beginners; once a sheet feels easy, the dense reference (cs fundamentals <topic> / cs -d <topic>) is one command away.
Current ramp-up topics (55): linux-kernel, bgp, tcp, udp, ip, icmp, tls, dns, websocket, http3-quic, ebpf, assembly, binary-numbering, oauth-oidc, saml, docker, kubernetes, github-actions, ansible, terraform, postgres, git, bash, python, prometheus, ssh, vim, regex, systemd, wireshark, redis, vault, make, grafana, opentelemetry, nginx, rust, go, mysql, iptables, aws-cli, helm, graphql, grpc, mongodb, osi-model, wifi, sdn, spine-leaf, spanning-tree, anycast, queue-management, iot-protocols, named-data-networking, network-automation.
cs calc "2**10" # 1024
cs calc "0xff * 2" # 510
cs calc "1<<16" # 65536
cs calc "10GB / 1500bytes" # unit-aware: 6,666,666 packets
cs calc "10Gbps / 8" # 1.25 Gbps
cs calc help # full calculator manual
cs subnet 10.0.0.0/24 # network, broadcast, host range, mask
cs subnet 172.16.0.0/20 # usable hosts, wildcard, binary mask
cs subnet help # full subnet calculator manual
cs verify bgp # check worked examples against the calculator
cs verify # verify all detail pages (CI-friendly, exit 1 on fail)cs -i # full-screen interactive browserKeys: j/k navigate, enter open, / filter, d detail page, esc back, q quit, ? full help overlay.
Inside / filter: ↑/↓ recall persisted history (~/.cache/vor/tui-history, max 50 entries).
Theme palette is configurable via ~/.config/vor/theme.json (8 hex colors, all optional).
See cs interactive-tui-config for the full setup walkthrough.
cs serve # 127.0.0.1:9876
cs serve 8080 # custom port| Method | Endpoint | Returns |
|---|---|---|
| GET | /api/topics |
all topics |
| GET | /api/topics/:name |
sheet content (JSON) |
| GET | /api/topics/:name/detail |
detail page |
| GET | /api/topics/:name/related |
related topics |
| GET | /api/categories |
category list |
| GET | /api/search?q=<query> |
full-text search |
| GET | /api/compare?a=<X>&b=<Y> |
compare two topics |
| POST | /api/calc |
evaluate expression |
| POST | /api/subnet |
subnet calculator |
| GET | /api/verify/:name |
verify detail math |
| GET | /api/stats |
statistics |
| GET | /api/bookmarks |
list bookmarks |
| POST | /api/bookmarks/:name |
toggle bookmark |
| GET | /api/stackoverflow?q=<q> |
Stack Overflow lookup (bonus, opt-in; needs key) |
cs lvm --format markdown # raw markdown (pipe to pbcopy, wiki, etc.)
cs lvm --format json # structured JSON
cs bgp --format json | jq . # pipe to jq
cs --star lvm # toggle bookmark
cs --starred # list bookmarks
cs --update # check GitHub releases and updatevör is offline-first. The default vor invocation makes zero network calls. The -so / --stack-overflow flag is an opt-in shortcut for the residual ~5% of cases the offline corpus doesn't cover (fresh error messages, version-specific gotchas).
vor -so help # onboarding text — how to obtain a free Stack Exchange key
vor stack-overflow-cli # the dedicated setup sheet (offline)
vor -so "lvm cannot extend" # live search (only after a key is configured)Without STACK_OVERFLOW_API_KEY set (env or ~/.config/vor/secrets.env, mode 0600), the flag prints onboarding text and exits 1. With a key, results are rendered through the same glamour pipeline as every other vor command and cached on disk for 24h. The key never appears in error output, log lines, or the cache file — verified by make audit-secrets. See vor stack-overflow-cli for the full walkthrough including key generation.
mobile/Cscore.xcframework/ is a generated artifact, gitignored. Rebuild:
make mobile-ios # gomobile bind ./mobile/ → mobile/Cscore.xcframeworkUsed by the React Native CsApp/ project for iOS distribution.
63 categories. Run cs --count for the live breakdown with sheet counts and a per-category bar chart. Starting points:
| Goal | Entry point |
|---|---|
| Total beginner — kernel ELI5 | cs ramp-up linux-kernel-eli5 |
| Network engineer (CCNP/CCIE) | cs networking |
| Security / pentesting | cs security, cs offensive |
| Platform / SRE | cs orchestration kubernetes |
| Linux internals | cs fundamentals linux-kernel-internals |
| Language reference | cs languages |
| Database internals | cs databases |
Every sheet includes ## See Also cross-references and ## References with official docs, RFCs, man pages, vendor guides.
Custom sheets live in ~/.config/vor/sheets/<category>/<topic>.md and override embedded ones.
cs --add ~/my-cheatsheet.md # prompts for category
cs --edit docker # copies embedded → custom for editingIndex any project's markdown alongside the embedded cheatsheets by symlinking it into ~/.config/vor/sources/. No config file, no glob rules — anything you symlink gets walked, and the existing .md-only filter handles the rest.
mkdir -p ~/.config/vor/sources
# Add a project — index all its markdown
ln -s ~/work/some-project ~/.config/vor/sources/some-project
# Add another
ln -s ~/code/notes ~/.config/vor/sources/notes
# Remove a source
rm ~/.config/vor/sources/some-project
# See what's hooked up
ls -la ~/.config/vor/sources/cs rebuilds its registry on every start, so changes (new symlinks, removed ones, edits to source markdown) are picked up at the next invocation. Dangling symlinks are silently skipped — you can safely rm a source's underlying directory and the next run still works.
# Tool Name (Full Description)
One-liner.
## Functional Area
### Specific Operation
` ` `bash
# Comment
command --flag value
` ` `
## Tips
- Practical gotcha or note
## See Also
- related-topic1, related-topic2
## References
- [Official Docs](https://example.com)
- [RFC 1234](https://www.rfc-editor.org/rfc/rfc1234)
- [man page(1)](https://man7.org/linux/man-pages/man1/page.1.html)make build # ./vor binary (cs symlinked)
make test # tests with race detector
make install # install to /usr/local/bin
make lint # go vet + audit-see-also + audit-secrets
make audit-see-also # detect dangling `## See Also` references
make audit-secrets # scan source for accidentally-committed credentials
make fmt # gofmt -s -w
make mobile-ios # rebuild iOS xcframeworkRequires Go 1.24+.
GPL-3.0-or-later. See LICENSE.