[!NOTE] This npm package distributes the Terminal User Interface (TUI) version of octoNote. If you want the Desktop GUI version, please check the main GitHub Repository.

😤 The Problem

You're a developer coding away in your terminal. You need to quickly copy a JSON payload, sketch a rough database schema, draft an email, or keep a temporary todo checklist.

And this happens every day:

# You open nano or vim.
# You type your notes.
# Later, you want to close it:
"Save modified buffer?"  ← 💀 annoying prompt.

# Or you name it temp_123.txt and throw it in ~/Desktop.
# Now your Desktop is a graveyard of 80 unnamed text files.
# Or your terminal session closes, and your unsaved buffer is gone forever.

octoNote is the permanent fix. A dedicated scratchpad workspace that opens instantly inside your terminal, supports multiple tabs, and auto-saves every single character to disk. You never name a scratch file, and you never hit save.

📦 Installation

This npm package automatically downloads the optimized Go binary matching your operating system and architecture upon installation.

# Install globally
npm install -g octonote

# Or run instantly without installation using npx
npx octonote

⚡ Quick Start

Launch the terminal scratchpad with one command:

octonote

✦ octonote
 1: scratch   2: ideas   3: todo   [+]
╭──────────────────────────────────────────╮
│ Start typing…                            │
│                                          │
╰──────────────────────────────────────────╯
^N new  ^W close  ^→/← switch  Tab cycle  ^C quit          ✓ saved 21:04:55

Write notes, open multiple tabs, exit anytime, and reopen. Everything is exactly where you left it.

🏆 Why octoNote?

| Feature | octoNote | nano / vim | standard Notes App | |---------|:--------:|:--------------:|:------------------:| | Instantly open | ✅ | ✅ | ❌ | | Keyboard-driven TUI | ✅ | ✅ | ❌ | | Multi-tab workspace | ✅ | ❌ | ❌ | | Auto-save on every keystroke | ✅ | ❌ | ⚠️ sync delay | | Crash-proof atomic writes | ✅ | ❌ | ❌ | | Zero file naming overhead | ✅ | ❌ | ❌ |

✨ Features

• 📝 Zero-Management Notes — Create and destroy tabs on the fly with shortcuts. No "Save as..." prompts. No files or directory trees to organize.
• 🛡️ Crash-Proof Engine — Saves state on every single keystroke. Uses atomic temp-file swaps so you never lose or corrupt your notes.
• 💻 Platform-Native Storage — Saves to standardized locations depending on your OS.
• 🚀 Built in Go — Ultra-lightweight, extremely fast startup, minimal memory consumption.

⌨️ Keyboard Shortcuts

| Shortcut | Action | |---|---| | Ctrl+N | Create new tab | | Ctrl+W | Delete / close current tab | | Ctrl+Tab | Switch to next tab | | Ctrl+Shift+Tab | Switch to previous tab | | Ctrl+1 ... Ctrl+9 | Jump directly to tab by index | | Tab | Cycle focus between tab bar and text area | | Ctrl+C | Quit application |

📁 Persistence

Notes are saved as state.json inside your platform's standard configuration directory:

• macOS: ~/Library/Application Support/octonote/state.json
• Linux: ~/.config/octonote/state.json
• Windows: %APPDATA%\octonote\state.json

📄 License

Apache License, Version 2.0 — see LICENSE for details.