cli + tui to publish to leaflet (wip) & manage tasks, notes & watch/read lists 馃崈
charm
leaflet
readability
golang
1---
2title: Getting Started
3sidebar_label: Getting Started
4description: Installation steps, configuration overview, and ways to find help.
5sidebar_position: 5
6---
7
8# Getting Started
9
10## Installation and Setup
11
12### System Requirements
13
14- Go 1.24 or higher
15- SQLite 3.35 or higher (usually bundled)
16- Terminal with 256-color support
17- Unix-like OS (Linux, macOS, WSL)
18
19### Building from Source
20
21Clone the repository and build:
22
23```sh
24git clone https://github.com/stormlightlabs/noteleaf
25cd noteleaf
26go build -o ./tmp/noteleaf ./cmd
27```
28
29Install to your GOPATH:
30
31```sh
32go install
33```
34
35### Database Initialization
36
37Run setup to create the database and configuration file:
38
39```sh
40noteleaf setup
41```
42
43This creates:
44
45- Database at platform-specific application data directory
46- Configuration file at platform-specific config directory
47- Default settings for editor, priorities, and display options
48
49### Seeding Sample Data
50
51For exploration and testing, populate the database with example data:
52
53```sh
54noteleaf setup seed
55```
56
57This creates sample tasks, notes, books, and other items to help you understand the system's capabilities.
58
59## Configuration Overview
60
61Configuration lives in `config.toml` at the platform-specific config directory.
62
63**Editor Settings**:
64
65```toml
66[editor]
67command = "nvim"
68args = []
69```
70
71**Task Defaults**:
72
73```toml
74[task]
75default_priority = "medium"
76default_status = "pending"
77```
78
79**Display Options**:
80
81```toml
82[display]
83date_format = "2006-01-02"
84time_format = "15:04"
85```
86
87View current configuration:
88
89```sh
90noteleaf config show
91```
92
93Update settings:
94
95```sh
96noteleaf config set editor vim
97```
98
99See the [Configuration](../Configuration.md) guide for complete options.
100
101## Getting Help
102
103Every command includes help text:
104
105```sh
106noteleaf --help
107noteleaf task --help
108noteleaf task add --help
109```
110
111For detailed command reference, run `noteleaf --help` and drill into the subcommand-specific help pages.