Install#

Install from source:

git clone https://github.com/abegong/katalyst
cd katalyst
make build

Quickstart#

mkdir my-notes && cd my-notes
katalyst init
katalyst check

katalyst init prepares the current directory as a katalyst project:

• .katalyst/config.yaml, commented project settings
• .katalyst/schemas/, one schema per file (empty to start)
• .katalyst/storage/local.yaml, the default storage instance (the local filesystem), where you declare collections

It writes no example content. Add a schema under .katalyst/schemas/ and declare a collection inside .katalyst/storage/local.yaml, then run katalyst check.

Next:

• Configuration
• Check types reference