Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Navor

A plain-text investment record for evidence, judgment, execution, and review.

Navor is a plain-text language and toolchain for long-term investors. Record confirmed facts, connect research to a thesis and a decision, execute in a ledger, then review what changed. The repository stays reviewable in Git, readable in the local Reader, and exportable as a static site.

Research, theses, decisions, reviews, journals, and transactions are first-class facts. Holdings, allocation, and PnL are derived views, so the reasoning behind a portfolio remains auditable.

中文文档 · Manifesto · Documentation

Install

Node.js 22.14 or later.

npm install --global @navor/cli
nav serve example

From source:

pnpm install && pnpm build
nav serve example

Minimal example

2026-01-01 open Account:US "US equities"
  target: 100%

2026-01-01 open Asset:Equity:US:NVDA "NVIDIA"
  account: Account:US

2026-01-02 thesis Asset:Equity:US:NVDA "Compute demand"
  confidence: Medium
  ---
  Revisit the thesis after earnings.
  ---

Commands

Command Purpose
nav serve <workspace> Local Reader (<workspace> is the repository path)
nav build <workspace> --out <dir> Static site
nav check <workspace> Validate parser and semantic diagnostics
nav format <path> [--check] Format .nav files

Editor highlighting and format-on-save: extensions/vscode. Install navor-*.vsix from Releases.

AI skills

Install Navor's portable Agent Skills for Codex, Cursor, Claude Code, or another supported agent:

npx skills add xwartz/navor --list
npx skills add xwartz/navor --skill '*' --agent codex

Add --global to make them available across projects. See AI assistant skills for the available skills and privacy note.

Data boundary

Navor does not upload a repository or require an account. Live prices are optional enrichment. Read market data and privacy before exposing a price proxy.

Contributing

Read CONTRIBUTING.md. Report security issues via SECURITY.md.

About

An open specification for representing investment state as human-readable documents.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages