esbi-cli documentation¶
esbi-cli (sb) turns the PDFs, links and emails you save into a Markdown wiki of notes, written by a local or cloud language model. These pages show how to install it, use it, and look things up. The notes it writes are in the language you choose (English or Spanish); the documentation and the command line are in English.
Start here¶
Pick the path that matches what you want to do.
-
I want to install it
From nothing to a working
sb, and a first note, in about half an hour. -
I want to learn it by using it
A week of short steps: save, read, tick, ask, run it every night.
-
I want to look something up
Every command, every setting, every file, every word.
Which page do I need?¶
| I want to... | Go to |
|---|---|
| Install it on a Mac, or from source | Install |
| Make my first note, step by step | Getting started |
| Set up a habit over a week | A first week |
| Add a link, a PDF, a folder, an image, a clip | Get sources in |
| See what is waiting, or retry something that failed | Manage the queue and old notes |
| Read today's notes and tick them | Read your notes |
| Ask my notes a question | Ask your wiki |
| Choose, change or compare models | Choose how the notes are written |
| Capture email, or clips and YouTube from the browser | Capture email, Web Clipper and YouTube |
| Have it run by itself every night | Run it every night |
| Back up, restore, or move to a new Mac | Back up and restore, Move to a new Mac |
| Update or remove it | Update and uninstall |
| Use it without Obsidian, or offline | Without Obsidian, Offline |
| Fix an error message | Troubleshooting |
| Find a command or a flag | Command reference |
| Change a setting | Configuration |
Drive sb from a script or an editor plugin |
JSON output |
| Know what each file in the vault is | What lives where |
| Understand a word | Concepts and glossary |
| Know what leaves my machine | Safety and privacy |
| Get a quick answer (cost, speed, languages, other systems) | FAQ |
| Understand how it works inside | How it works, Why it is built this way, Architecture |
How the documentation is organised¶
- Learn is a guided path with every output shown.
- Do is one recipe per task.
- Look up is complete and exact: commands, settings, files.
- Understand explains why, with measurements where they exist.
Version 0.x: it works and is used daily, but commands and the config format can still change between minor versions; see the changelog. Released under the MIT license. Source and issues: GitHub.