---

title: Getting Started sidebar_label: Getting Started description: Installation steps, configuration overview, and ways to find help. sidebar_position: 5 #

Getting Started #

Installation and Setup #

System Requirements #

• Go 1.24 or higher
• SQLite 3.35 or higher (usually bundled)
• Terminal with 256-color support
• Unix-like OS (Linux, macOS, WSL)

Building from Source #

Clone the repository and build:

git clone https://github.com/stormlightlabs/noteleaf
cd noteleaf
go build -o ./tmp/noteleaf ./cmd

Install to your GOPATH:

go install

Database Initialization #

Run setup to create the database and configuration file:

noteleaf setup

This creates:

• Database at platform-specific application data directory
• Configuration file at platform-specific config directory
• Default settings for editor, priorities, and display options

Seeding Sample Data #

For exploration and testing, populate the database with example data:

noteleaf setup seed

This creates sample tasks, notes, books, and other items to help you understand the system's capabilities.

Configuration Overview #

Configuration lives in config.toml at the platform-specific config directory.

Editor Settings:

[editor]
command = "nvim"
args = []

Task Defaults:

[task]
default_priority = "medium"
default_status = "pending"

Display Options:

[display]
date_format = "2006-01-02"
time_format = "15:04"

View current configuration:

noteleaf config show

Update settings:

noteleaf config set editor vim

See the Configuration guide for complete options.

Getting Help #

Every command includes help text:

noteleaf --help
noteleaf task --help
noteleaf task add --help

For detailed command reference, run noteleaf --help and drill into the subcommand-specific help pages.