saveinme
v2.0.0
Published
Your personal terminal notebook — save anything, permanently.
Maintainers
Readme
💾 saveinme
Your personal terminal notebook — save anything, permanently.
Install
To install globally from npm:
npm install -g saveinmeOr for local development:
cd path/to/saveinme
npm install
npm linkNote: Once installed, both the
saveinmeandsimcommands are registered globally and can be used interchangeably in any terminal window!
Commands
Both
saveinmeandsimcan be used interchangeably!
| Command | What it does |
|---|---|
| saveinme or sim | List all your saved notes |
| saveinme <title> | Directly view a note by its title |
| saveinme -ui | Launch the Split-Pane TUI Dashboard (keyboard-driven screen) |
| saveinme -c | Create a new note or edit an existing one |
| saveinme -c <title> | Jump straight to editing/creating a note by title |
| saveinme -c <title> -n <notebook> | Create/edit a note inside a specific notebook |
| saveinme -cl | Instantly save system clipboard content as a note |
| saveinme -cl <title> | Save clipboard content directly with a specific title |
| saveinme -d | Set/select the default target notebook for new notes (opens interactive list) |
| saveinme -d <notebook> | Set the default target notebook directly |
| saveinme -v | View a note (opens interactive select menu) |
| saveinme -v <title> | View a specific note in full |
| saveinme -rm | Remove notes (opens interactive multi-select checkbox menu) |
| saveinme -rm <title> | Delete a specific note |
| saveinme -p <title> | Toggle pin (pinned notes appear at the top) |
| saveinme -f <term> | Search by title, content, tags, or category |
| saveinme -ai | Start an interactive AI chat session with Gemini |
| saveinme -ai <query> | Query notes database via Gemini AI |
| saveinme -ai --setup | Configure Gemini API key |
| saveinme --sync | Sync notes database push/pull to remote repository |
| saveinme --sync --setup | Configure Git remote sync URL |
| saveinme --path | Show where your notes are stored |
| saveinme -h | Help |
Notebook Target & Command Piping
Default Notebook Target
You can lock the default notebook (category) where your notes go:
sim -d "Work"Once set, any new note created via sim -c or sim -cl will default to the "Work" notebook automatically.
- View current target / Select from list:
sim -d - Clear default target:
sim -d --clear
Override Notebook
Send a note to a specific notebook at any time using the -n or --notebook flag at the end of your command:
sim -c "Todo List" -n "Personal"Stdin Piping
You can pipe the standard output of any command directly into a note!
# Save search results directly to a note
grep -rn "TODO" src/ | sim -c "Code TODOs"
# Save wget/curl responses instantly
curl https://api.github.com/zen | sim -c "Zen Quote" -n "Quotes"The content will be saved instantly with the specified title and target notebook. If no title is specified, it will auto-generate one based on the first line.
What gets saved per note
- Title — a short name for the note
- Content — multi-line text, written right in the terminal
- Category — group notes together (e.g.
work,personal) - Tags — multiple tags for cross-cutting topics (e.g.
#todo,#idea) - Priority — Low / Medium / High
- Pinned — pinned notes always appear at the top of the list
- Created date — set automatically
- Updated date — updated automatically on every save
- Word count and char count — calculated automatically
In-terminal editor
When you run saveinme -s, you'll be guided through prompts. When you reach the content area:
❯ This is line one
❯ This is line two
❯ :saveType :save on a new blank line and press Enter to save.
Type :cancel to discard.
Type :keep (when editing) to keep the existing content unchanged.
Works on Windows (PowerShell / CMD) and Linux/macOS — no external editor opens.
Split-Pane TUI Dashboard (sim -ui)
Open a visual workspace right inside your terminal:
sim -ui- Navigation: Use Up/Down arrows (or
j/kVim keys) to browse notes. - Preview: Note content and details update in real-time on the right.
- Controls:
Enter— Edit the selected note.c— Create a new note.p— Pin/unpin the selected note.d— Delete the selected note (with confirmation)./— Enter search mode (type search terms,Enterto filter,Escto clear).qorEsc— Quit dashboard.
AI Copilot (Gemini / Ollama) (sim -ai)
Query your notes using Google's Gemini AI (cloud-based) or Ollama (completely local and offline):
# Initial Setup / Reset (prompts you to choose between Gemini or local Ollama)
sim -ai --setup
sim -ai --reset
# Ask questions directly based on your saved notes
sim -ai "which server port was mentioned in the api note?"
sim -ai "summarize the highlights of the book list note"
# Start an interactive chat session
sim -ai- Gemini: Setup prompts for a Google AI Studio API key (free tier available).
- Ollama: Setup prompts for your local server endpoint (default:
http://localhost:11434) and local model name (default:llama3). Ensure you have downloaded the model first (e.g. runollama run llama3in your terminal).
Git Auto-Sync (sim --sync)
Sync your notes across multiple devices using a private Git repository:
# Setup remote URL (SSH preferred)
sim --sync --setup
# Manually trigger a full push/pull sync
sim --syncOnce configured, saveinme will automatically run background syncs when you save or delete notes, keeping everything synced silently!
Note: Config files (such as those storing secret API keys) are automatically ignored by Git to protect your security.
Storage
Notes are stored permanently at:
~/.saveinme/notes.jsonThis file persists across sessions and reboots. Back it up any time.
