Pad

Pad is a lightweight note-taking CLI with a superpower: it can store runnable shell commands and execute them later.

Think of it as a personal notebook for commands, notes, and quick automation tasks.

Features

• Create normal notes
• Create command notes for shell commands
• Open notes in your editor for natural writing
• List all saved notes
• Read notes back in the terminal
• Update and delete notes
• Run saved command notes with pad run <name>

Installation

From the project root:

uv tool install --editable .

If you want to work in the project environment instead:

uv sync
source .venv/bin/activate

Usage

Create a normal note

pad init mynote

This creates a note file in the pad_notes folder and opens it in your editor ($EDITOR, default: vim).

Create a command note

pad init -c docker

This creates an empty command note that you then fill with a command like:

docker compose exec web python manage.py migrate directory

Then execute it with:

pad run docker

List notes

pad list

Read a note

pad read mynote

Update a note

pad update mynote

This opens the note in your editor for editing.

Delete a note

pad delete mynote

Example note structure

For a command note, the file should contain only the command text, for example:

docker compose exec web python manage.py migrate directory

This keeps the note simple and lets pad run execute it directly.

Project layout

pad/
├── README.md
├── LICENSE
├── pyproject.toml
├── src/
│   └── pad/
│       ├── __init__.py
│       └── core.py
└── pad_notes/

Development

Run the tests:

uv run pytest

Author

Malith Gamage

License

This project is licensed under the MIT License. See LICENSE for details.