Search

PythonReactSEOPDF
GitHub Skill

remarkable-upload

Upload Markdown and source files to a reMarkable device as PDFs using the remarquee CLI (rmapi-backed). Use when the user asks to upload/send/export docs/examples to reMarkable, bundle multiple files into one PDF with a ToC, choose an /ai/YYYY/MM/DD destination, avoid or force overwrites, or troubleshoot pandoc/xelatex/rmapi auth.

wesen☆ 1 Repository stars0 Repository forks

Installation

Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.

View source ↗Guides

Skill instructions

Remarkable Upload

Preconditions

  1. Confirm remarquee exists:
    • remarquee status
  2. Confirm PDF tooling if needed:
    • pandoc, xelatex
  3. Confirm cloud auth if needed:
    • remarquee cloud account --non-interactive (or run without --non-interactive to complete one-time code)

Workflow (safe default, recommended)

  1. Choose inputs (use absolute paths when possible).
  2. Dry-run first:
    • Single/many markdown: remarquee upload md --dry-run <path...>
    • Bundled markdown (one PDF + ToC): remarquee upload bundle --dry-run <path...>
    • Source code PDFs: remarquee upload src --dry-run <path...>
  3. Upload (no overwrite):
    • Same commands without --dry-run
  4. Overwrite only if explicitly requested (WARNING: deletes existing document + annotations):
    • add --force

Bundling multiple files (preferred)

  • Bundle multiple markdown inputs into a single PDF with a clickable ToC:
    • remarquee upload bundle <path...> --name "<doc name>" --remote-dir "/ai/YYYY/MM/DD/<folder>" --toc-depth 2
  • Bundle multiple source files into a single syntax-highlighted PDF:
    • remarquee upload src <path...> --bundle --include-ext .go --name "<doc name>" --remote-dir "/ai/YYYY/MM/DD/<folder>" --toc-depth 2

Tip: if you care about ToC order and titles, copy/rename files into a temp folder with numeric prefixes, then pass that directory to bundle.

Ticket-aware uploads (recommended)

  • Put uploads under a stable ticket folder (avoids collisions):
    • Remote: /ai/YYYY/MM/DD/<TICKET-ID>/
    • Use --date YYYY/MM/DD (or --remote-dir ...) explicitly.
  • Verify results:
    • remarquee cloud ls /ai/YYYY/MM/DD/<TICKET-ID> --long --non-interactive

Legacy fallback (only if needed)

If remarquee is unavailable, the older uploader script can still be used:

  • Dry-run: python3 /home/manuel/.local/bin/remarkable_upload.py --dry-run /abs/path/to/doc.md
  • Upload: python3 /home/manuel/.local/bin/remarkable_upload.py /abs/path/to/doc.md
  • Overwrite: python3 /home/manuel/.local/bin/remarkable_upload.py --force /abs/path/to/doc.md

Reference

  • Full guide + troubleshooting: references/remarkable.md

Examples

Read the usage examples in the source repository.

View source ↗

Source history

Indexed on
2026-01-20
Index updated
2026-02-05
Branch
main

Index and sync dates describe this directory. View the source repository for code history.

GitHub ↗

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!