Skip to main content

notesctl

Export Apple iCloud Notes to Markdown files safely.

Features

  • Safe: Copies database before reading, uses read-only mode
  • Complete: Exports text, formatting, and attachments
  • Organized: Groups notes by folder with YAML frontmatter

Installation

# Using uv (recommended)
uv pip install .

# Or install in development mode
uv pip install -e ".[dev]"

Usage

# Export all notes
uv run notesctl export -o ~/notes-backup

# Export specific folder
uv run notesctl export --folder "Work" -o ~/work-notes

# Preview without writing (safe)
uv run notesctl export --dry-run

# List notes
uv run notesctl list-notes

# List folders
uv run notesctl list-folders

# Show statistics
uv run notesctl stats

Safety

This tool prioritizes safety:

  1. Copy-first: Database files are copied to temp directory before reading
  2. Read-only: SQLite connection uses URI mode=ro
  3. SELECT only: All queries are validated to be SELECT statements
  4. Dry-run mode: Preview exports without writing files

Development

make check # lint, format, types, lock, package build
make test  # real local Apple Notes reads

Live checks require a populated Apple Notes database and macOS file access. They read database copies and preview a Markdown export through the installed CLI. They never write to Apple Notes or save exported notes. CI runs static and package checks. The project has no unit or mock test suite.

Use notesctl --version or notesctl version for the package version. Use notesctl doctor --json to verify database access and read note counts. Command errors use stderr; data and tables use stdout.

Requirements

  • macOS with Apple Notes
  • Python 3.11+
  • uv (recommended) or pip

Metadata

Release files for notesctl 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for notesctl 1.1.0
File Size Uploaded Provenance Actions
notesctl-1.1.0.tar.gz 51.8 kB With provenance Details for notesctl-1.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for notesctl 1.1.0
File Interpreter ABI Platform Actions
notesctl-1.1.0-py3-none-any.whl Python 3 none any Details for notesctl-1.1.0-py3-none-any.whl

Total release size: 77.2 kB

Release files / notesctl-1.1.0.tar.gz

Download URL notesctl-1.1.0.tar.gz
Size 51.8 kB
Tags Source
SHA-256 checksum
How to use checksums
cd743d5e48636eb25566a819ba7094a5162ff2b75c753f160d820acc3e37b642
BLAKE2b-256 checksum
How to use checksums
7874f9730bc96d94a7ca43131d89ed23321e3060c063fe69bee7571ea4bb9d3a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.

Transparency log

Release files / notesctl-1.1.0-py3-none-any.whl

Download URL notesctl-1.1.0-py3-none-any.whl
Size 25.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
32fb6af602dc98cd382b531d835dcfbbcb0a04395ddcc4487f26fec7437eb195
BLAKE2b-256 checksum
How to use checksums
c5340f3b1beeccdb54ac75a9e53fef23036f9e3998d42974b6131c9a7e8a7636
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.

Transparency log

Security for notesctl 1.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for notesctl-1.1.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page