cli + tui to publish to leaflet (wip) & manage tasks, notes & watch/read lists 馃崈
charm
leaflet
readability
golang
1# Quickstart Guide
2
3This guide will walk you through installing Noteleaf and getting productive with tasks, notes, and media tracking in under 15 minutes.
4
5## Installation
6
7### Requirements
8
9- Go 1.24 or higher
10- Git (for cloning the repository)
11
12### Build and Install
13
14Clone the repository and build the binary:
15
16```sh
17git clone https://github.com/stormlightlabs/noteleaf
18cd noteleaf
19go build -o ./tmp/noteleaf ./cmd
20```
21
22Optionally, install to your GOPATH:
23
24```sh
25go install
26```
27
28## Initialize Noteleaf
29
30Set up the database and configuration:
31
32```sh
33noteleaf setup
34```
35
36This creates:
37
38- Database at `~/.local/share/noteleaf/noteleaf.db` (Linux) or `~/Library/Application Support/noteleaf/noteleaf.db` (macOS)
39- Configuration file at `~/.config/noteleaf/config.toml` (Linux) or `~/Library/Application Support/noteleaf/config.toml` (macOS)
40
41### Optional: Add Sample Data
42
43Explore with pre-populated examples:
44
45```sh
46noteleaf setup seed
47```
48
49## Task Management
50
51### Create Your First Task
52
53```sh
54noteleaf task add "Write project proposal"
55```
56
57### Add a Task with Priority and Project
58
59```sh
60noteleaf task add "Review pull requests" --priority high --project work
61```
62
63### List Tasks
64
65Interactive mode with arrow key navigation:
66
67```sh
68noteleaf task list
69```
70
71Static output for scripting:
72
73```sh
74noteleaf task list --static
75```
76
77### Mark a Task as Done
78
79```sh
80noteleaf task done 1
81```
82
83### Track Time
84
85Start tracking:
86
87```sh
88noteleaf task start 1
89```
90
91Stop tracking:
92
93```sh
94noteleaf task stop 1
95```
96
97View timesheet:
98
99```sh
100noteleaf task timesheet
101```
102
103## Note Taking
104
105### Create a Note
106
107Quick note from command line:
108
109```sh
110noteleaf note create "Meeting Notes" "Discussed Q4 roadmap and priorities"
111```
112
113Create with your editor:
114
115```sh
116noteleaf note create --interactive
117```
118
119Create from a file:
120
121```sh
122noteleaf note create --file notes.md
123```
124
125### List and Read Notes
126
127List all notes (interactive):
128
129```sh
130noteleaf note list
131```
132
133Read a specific note:
134
135```sh
136noteleaf note read 1
137```
138
139### Edit a Note
140
141Opens in your `$EDITOR`:
142
143```sh
144noteleaf note edit 1
145```
146
147## Media Tracking
148
149### Books
150
151Search and add from Open Library:
152
153```sh
154noteleaf media book add "Project Hail Mary"
155```
156
157List your reading queue:
158
159```sh
160noteleaf media book list
161```
162
163Update reading progress:
164
165```sh
166noteleaf media book progress 1 45
167```
168
169Mark as finished:
170
171```sh
172noteleaf media book finished 1
173```
174
175### Movies
176
177Add a movie:
178
179```sh
180noteleaf media movie add "The Matrix"
181```
182
183Mark as watched:
184
185```sh
186noteleaf media movie watched 1
187```
188
189### TV Shows
190
191Add a show:
192
193```sh
194noteleaf media tv add "Breaking Bad"
195```
196
197Update status:
198
199```sh
200noteleaf media tv watching 1
201```
202
203## Articles
204
205### Save an Article
206
207Parse and save from URL:
208
209```sh
210noteleaf article add https://example.com/interesting-post
211```
212
213### List Articles
214
215```sh
216noteleaf article list
217```
218
219Filter by author:
220
221```sh
222noteleaf article list --author "Jane Smith"
223```
224
225### Read an Article
226
227View in terminal:
228
229```sh
230noteleaf article view 1
231```
232
233## Configuration
234
235### View Current Configuration
236
237```sh
238noteleaf config show
239```
240
241### Set Configuration Values
242
243```sh
244noteleaf config set editor vim
245noteleaf config set default_priority medium
246```
247
248### Check Status
249
250View application status and paths:
251
252```sh
253noteleaf status
254```
255
256## Getting Help
257
258View help for any command:
259
260```sh
261noteleaf --help
262noteleaf task --help
263noteleaf task add --help
264```
265
266## Next Steps
267
268Now that you have the basics down:
269
270- Explore advanced task filtering and queries
271- Create custom projects and contexts for organizing tasks
272- Link notes to tasks and media items
273- Set up recurring tasks and dependencies
274- Configure the application to match your workflow
275
276For detailed documentation on each command, see the CLI reference in the manual section.