| Name | shellpad JSON |
| Version |
1.1
JSON |
| download |
| home_page | None |
| Summary | A minimalist notebook for your shell. |
| upload_time | 2025-10-24 04:13:27 |
| maintainer | None |
| docs_url | None |
| author | wormcracker |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
terminal
notes
markdown
cli
tui
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Shellpad
> **A lightweight terminal-based notes editor**
> Minimal, fast, and markdown-friendly — perfect for note-takers who live in the terminal.
---
## 🚀 Overview
**Shellpad** is a simple curses-powered Markdown notebook for your terminal.
It stores all notes in a single `shellpad.md` file and lets you view, edit, and manage them directly in the console — no extra dependencies, no bloat.
---
## ✨ Features
- 🗒️ Markdown-style notes stored in one file
- ✅ Checkbox preview for `[ ]` and `[x]` tasks
- ⚡ Realtime autosave
- 🖊️ In-terminal or external editor (e.g., Vim, Nano)
- 📋 System clipboard integration
- 🔗 Open URLs directly from the editor
- 🧭 Simple, keyboard-only navigation
---
## 🧩 Installation
- For Mac and Linux
```bash
pipx install shellpad
```
- For Windows
```bash
pipx install shellpad[windows]
```
## 🧩 Running locally
1. Clone the repository:
```bash
git clone https://github.com/wormcracker/shellpad.git
cd shellpad
```
2. Run directly:
```bash
python3 shellpad.py
```
3. (Optional) Make executable:
```bash
chmod +x shellpad.py
./shellpad.py
```
**Dependencies:**
Only Python 3.8+ — no external modules required.
(Optional clipboard tools: `xclip`, `xsel`, or `wl-clipboard` on Linux.)
---
## 🪶 Usage
### Basic Controls
| Mode | Key | Action |
| ------------- | -------------- | ---------------------------------- |
| **List view** | `j / k` | Move down / up |
| | `a` | Add new note |
| | `o` or `Enter` | Open note in internal editor |
| | `O` | Open in external editor |
| | `y` | Copy note internally |
| | `p` | Paste copied note / clipboard |
| | `Y` | Copy note body to system clipboard |
| | `r` | Rename note |
| | `d` | Delete note |
| | `[` / `]` | Move note up / down |
| | `?` | Show help |
| | `q` | Quit |
| **Editor** | `ESC` | Save and return |
| | `Ctrl+V` | Paste from system clipboard |
| | `Ctrl+W` | Delete previous word |
---
## ⚙️ Configuration
Config file:
`~/.config/shellpad/config.cfg`
`%APPDATA%\shellpad\config.cfg (Windows)`
Example:
```
notebook_file: ~/shellpad.md
external_editor: false
default_editor: vim
wrap_lines: true
realtime_save: true
doing_symbol: +
done_symbol: -
```
**Options:**
- `notebook_file` — Path to your notes file
- `external_editor` — Use system editor (true/false)
- `default_editor` — Which external editor to use
- `realtime_save` — Save as you type
- `doing_symbol`, `done_symbol` — Customize preview icons
---
## 🗂️ Notes Format
Notes are stored in Markdown under H1 titles:
```markdown
# Grocery List
[ ] Buy milk
[x] Bread bought
# Ideas
A concept for a terminal-based wiki.
```
---
## 💡 Tips
- Copy and paste notes internally with `y` and `p`.
- Press `?` anytime for the built-in help window.
- Preview automatically wraps long lines.
- Works on Linux, macOS, and Windows (PowerShell-based clipboard).
---
## ⚖️ License
**MIT License** — © 2025 [sushant](https://github.com/wormcracker)
Use, modify, and share freely.
---
## 🌐 Links
- **GitHub:** [wormcracker/shellpad](https://github.com/wormcracker/shellpad)
- **Author:** sushant
- **Language:** Python 3 (no dependencies)
---
> “Simplicity is the final sophistication — Shellpad keeps your notes close and your focus closer.”
Raw data
{
"_id": null,
"home_page": null,
"name": "shellpad",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "terminal, notes, markdown, cli, tui",
"author": "wormcracker",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f4/b9/cdfe8ef24579a258ef9be0f23338cbf79235c5ca3e8a48a881e483c64792/shellpad-1.1.tar.gz",
"platform": null,
"description": "# Shellpad\n\n> **A lightweight terminal-based notes editor** \n> Minimal, fast, and markdown-friendly \u2014 perfect for note-takers who live in the terminal.\n\n---\n\n## \ud83d\ude80 Overview\n\n**Shellpad** is a simple curses-powered Markdown notebook for your terminal. \nIt stores all notes in a single `shellpad.md` file and lets you view, edit, and manage them directly in the console \u2014 no extra dependencies, no bloat.\n\n---\n\n## \u2728 Features\n\n- \ud83d\uddd2\ufe0f Markdown-style notes stored in one file\n- \u2705 Checkbox preview for `[ ]` and `[x]` tasks\n- \u26a1 Realtime autosave\n- \ud83d\udd8a\ufe0f In-terminal or external editor (e.g., Vim, Nano)\n- \ud83d\udccb System clipboard integration\n- \ud83d\udd17 Open URLs directly from the editor\n- \ud83e\udded Simple, keyboard-only navigation\n\n---\n\n## \ud83e\udde9 Installation\n\n- For Mac and Linux\n\n```bash\npipx install shellpad\n```\n\n- For Windows\n\n```bash\npipx install shellpad[windows]\n```\n\n## \ud83e\udde9 Running locally\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/wormcracker/shellpad.git\ncd shellpad\n```\n\n2. Run directly:\n\n```bash\npython3 shellpad.py\n```\n\n3. (Optional) Make executable:\n\n```bash\nchmod +x shellpad.py\n./shellpad.py\n```\n\n**Dependencies:** \nOnly Python 3.8+ \u2014 no external modules required. \n(Optional clipboard tools: `xclip`, `xsel`, or `wl-clipboard` on Linux.)\n\n---\n\n## \ud83e\udeb6 Usage\n\n### Basic Controls\n\n| Mode | Key | Action |\n| ------------- | -------------- | ---------------------------------- |\n| **List view** | `j / k` | Move down / up |\n| | `a` | Add new note |\n| | `o` or `Enter` | Open note in internal editor |\n| | `O` | Open in external editor |\n| | `y` | Copy note internally |\n| | `p` | Paste copied note / clipboard |\n| | `Y` | Copy note body to system clipboard |\n| | `r` | Rename note |\n| | `d` | Delete note |\n| | `[` / `]` | Move note up / down |\n| | `?` | Show help |\n| | `q` | Quit |\n| **Editor** | `ESC` | Save and return |\n| | `Ctrl+V` | Paste from system clipboard |\n| | `Ctrl+W` | Delete previous word |\n\n---\n\n## \u2699\ufe0f Configuration\n\nConfig file: \n`~/.config/shellpad/config.cfg`\n`%APPDATA%\\shellpad\\config.cfg (Windows)`\n\nExample:\n\n```\nnotebook_file: ~/shellpad.md\nexternal_editor: false\ndefault_editor: vim\nwrap_lines: true\nrealtime_save: true\ndoing_symbol: +\ndone_symbol: -\n```\n\n**Options:**\n\n- `notebook_file` \u2014 Path to your notes file\n- `external_editor` \u2014 Use system editor (true/false)\n- `default_editor` \u2014 Which external editor to use\n- `realtime_save` \u2014 Save as you type\n- `doing_symbol`, `done_symbol` \u2014 Customize preview icons\n\n---\n\n## \ud83d\uddc2\ufe0f Notes Format\n\nNotes are stored in Markdown under H1 titles:\n\n```markdown\n# Grocery List\n\n[ ] Buy milk\n[x] Bread bought\n\n# Ideas\n\nA concept for a terminal-based wiki.\n```\n\n---\n\n## \ud83d\udca1 Tips\n\n- Copy and paste notes internally with `y` and `p`.\n- Press `?` anytime for the built-in help window.\n- Preview automatically wraps long lines.\n- Works on Linux, macOS, and Windows (PowerShell-based clipboard).\n\n---\n\n## \u2696\ufe0f License\n\n**MIT License** \u2014 \u00a9 2025 [sushant](https://github.com/wormcracker)\n\nUse, modify, and share freely.\n\n---\n\n## \ud83c\udf10 Links\n\n- **GitHub:** [wormcracker/shellpad](https://github.com/wormcracker/shellpad)\n- **Author:** sushant\n- **Language:** Python 3 (no dependencies)\n\n---\n\n> \u201cSimplicity is the final sophistication \u2014 Shellpad keeps your notes close and your focus closer.\u201d\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A minimalist notebook for your shell.",
"version": "1.1",
"project_urls": null,
"split_keywords": [
"terminal",
" notes",
" markdown",
" cli",
" tui"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0baea0f2b42fb56a155b42e3937dc1eb6d22a3dfa32e26300ebc9086e6f1cca6",
"md5": "70b408e54fb8776f5a1ac780903cb59e",
"sha256": "5600206a509666ef5576dcc6ed05e8fd85816ace44ff950a9a1567bf160adf04"
},
"downloads": -1,
"filename": "shellpad-1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70b408e54fb8776f5a1ac780903cb59e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11089,
"upload_time": "2025-10-24T04:13:26",
"upload_time_iso_8601": "2025-10-24T04:13:26.810293Z",
"url": "https://files.pythonhosted.org/packages/0b/ae/a0f2b42fb56a155b42e3937dc1eb6d22a3dfa32e26300ebc9086e6f1cca6/shellpad-1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f4b9cdfe8ef24579a258ef9be0f23338cbf79235c5ca3e8a48a881e483c64792",
"md5": "e13c66e800fea51bf989b80900310bd2",
"sha256": "6ad6d4ebc29796d11647b91df62f1d8b60f4aa58e4d0cbf05203e0dab6e4985c"
},
"downloads": -1,
"filename": "shellpad-1.1.tar.gz",
"has_sig": false,
"md5_digest": "e13c66e800fea51bf989b80900310bd2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12284,
"upload_time": "2025-10-24T04:13:27",
"upload_time_iso_8601": "2025-10-24T04:13:27.843108Z",
"url": "https://files.pythonhosted.org/packages/f4/b9/cdfe8ef24579a258ef9be0f23338cbf79235c5ca3e8a48a881e483c64792/shellpad-1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-24 04:13:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "shellpad"
}
