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