Remarkable Upload
Preconditions
- •Confirm
remarqueeexists:- •
remarquee status
- •
- •Confirm PDF tooling if needed:
- •
pandoc,xelatex
- •
- •Confirm cloud auth if needed:
- •
remarquee cloud account --non-interactive(or run without--non-interactiveto complete one-time code)
- •
Workflow (safe default, recommended)
- •Choose inputs (use absolute paths when possible).
- •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...>
- •Single/many markdown:
- •Upload (no overwrite):
- •Same commands without
--dry-run
- •Same commands without
- •Overwrite only if explicitly requested (WARNING: deletes existing document + annotations):
- •add
--force
- •add
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.
- •Remote:
- •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