Skip to main content

GPGNotes - A CLI note-taking tool with GPG encryption, tagging, and Git sync

Project description

GPGNotes

Tests Lint License

A CLI note-taking tool with GPG encryption, automatic tagging, full-text search, and Git synchronization.

Features

  • Markdown Notes - Write notes in plain markdown with YAML frontmatter
  • GPG Encryption - Every note is encrypted individually with GPG
  • Full-Text Search - Fast SQLite FTS5-powered search across all notes
  • Auto-Tagging - Intelligent tag generation using TF-IDF
  • Git Sync - Automatic synchronization with private GitHub repositories
  • AI Enhancement - Optional LLM-powered note refinement (docs)
  • Import/Export - Support for PDF, DOCX, RTF formats (docs)

Installation

Prerequisites

  • Python 3.11 or higher
  • GPG (GnuPG) installed on your system
    • Linux: sudo apt install gnupg (Debian/Ubuntu)
    • macOS: brew install gnupg

Install from PyPI

pip install gpgnotes

With optional dependencies:

pip install gpgnotes[llm]      # AI enhancement
pip install gpgnotes[import]   # PDF/DOCX import/export

Install from source

git clone https://github.com/oscarvalenzuelab/GPGNotes.git
cd GPGNotes
pip install -e .

Quick Start

1. Initialize

notes init

This guides you through:

  • Selecting a GPG key
  • Testing encryption
  • Configuring your editor
  • Setting up Git sync (optional)

Don't have a GPG key? Create one:

gpg --full-generate-key

2. Create a note

notes new "My First Note"

3. Search and manage

notes search "keyword"
notes list
notes open <note-id>
notes sync

Command Reference

Command Description
notes new "Title" Create a new note
notes list List all notes
notes list --preview List with content preview
notes recent Show 5 most recent notes
notes search "query" Full-text search
notes search --tag work Search by tag
notes open <id> Open note by ID
notes open "title" Open by title (fuzzy match)
notes open --last Open most recent note
notes tags List all tags
notes delete <id> Delete a note
notes sync Sync with Git
notes config --show Show configuration
notes enhance <id> AI enhancement (docs)
notes import file.pdf Import file (docs)
notes export <id> Export note (docs)

Interactive Mode

Run notes without arguments for interactive mode with:

  • Tab completion for note titles
  • Command history (Up/Down arrows)
  • Quick search by typing

Security

  • GPG Encryption: All notes encrypted with AES256
  • Local-first: Your data stays on your machine
  • Private repos: Git sync for private repositories only
  • Encrypted secrets: API keys stored with GPG encryption

Documentation

License

Apache License 2.0 - see LICENSE for details.


Note: This is an early release. Always backup your notes!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gpgnotes-0.1.13.tar.gz (43.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gpgnotes-0.1.13-py3-none-any.whl (43.9 kB view details)

Uploaded Python 3

File details

Details for the file gpgnotes-0.1.13.tar.gz.

File metadata

  • Download URL: gpgnotes-0.1.13.tar.gz
  • Upload date:
  • Size: 43.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gpgnotes-0.1.13.tar.gz
Algorithm Hash digest
SHA256 1f54d9959aa2e0ed5cb1c26f3e57e6264fbca8b7c6a51041416e8463c3cc2313
MD5 987d6c4a15d86f27a7fac4232fdf438b
BLAKE2b-256 18cc28b2d03372042b2471f346ba8f0e9ef0cd8fd2a9e4e624e6cabcbcb84039

See more details on using hashes here.

Provenance

The following attestation bundles were made for gpgnotes-0.1.13.tar.gz:

Publisher: publish.yml on oscarvalenzuelab/GPGNotes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gpgnotes-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: gpgnotes-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 43.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gpgnotes-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 41a3b57bcd93a6d9211156b3344cdacb394e547685da41b4c06bf29327181b8d
MD5 706b040298968e83c2e1f2928a0bde74
BLAKE2b-256 023c5c79638878e30d73ea12836ce01bc01d1f9893b288d4a8bbdbbad78a59cf

See more details on using hashes here.

Provenance

The following attestation bundles were made for gpgnotes-0.1.13-py3-none-any.whl:

Publisher: publish.yml on oscarvalenzuelab/GPGNotes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page