{"id":13771146,"url":"https://github.com/hmenzagh/reMarkable-Sink","last_synced_at":"2025-05-11T03:33:04.676Z","repository":{"id":130672162,"uuid":"313399097","full_name":"hmenzagh/reMarkable-Sink","owner":"hmenzagh","description":"Ultra-simple node app that uploads files from a folder to your ReMarkable Tablet thanks to RmApi \u0026 watchman.","archived":false,"fork":false,"pushed_at":"2020-11-21T12:11:32.000Z","size":56,"stargazers_count":44,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-08T00:01:59.753Z","etag":null,"topics":["awesome","awesome-list","pdf","remarkable","remarkable-tablet"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hmenzagh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-11-16T18:58:34.000Z","updated_at":"2025-04-23T10:13:31.000Z","dependencies_parsed_at":"2023-05-31T14:15:19.496Z","dependency_job_id":null,"html_url":"https://github.com/hmenzagh/reMarkable-Sink","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmenzagh%2FreMarkable-Sink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmenzagh%2FreMarkable-Sink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmenzagh%2FreMarkable-Sink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmenzagh%2FreMarkable-Sink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hmenzagh","download_url":"https://codeload.github.com/hmenzagh/reMarkable-Sink/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253514352,"owners_count":21920327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["awesome","awesome-list","pdf","remarkable","remarkable-tablet"],"created_at":"2024-08-03T17:00:48.270Z","updated_at":"2025-05-11T03:33:04.650Z","avatar_url":"https://github.com/hmenzagh.png","language":"JavaScript","funding_links":[],"categories":["Cloud Tools"],"sub_categories":["Launchers"],"readme":"![logo](./assets/logo.png)\n\nUltra-simple node app that uploads files from a folder to your reMarkable Tablet thanks to [RmApi](https://github.com/juruen/rmapi) \u0026 [watchman](https://facebook.github.io/watchman/docs/install.html).\nIt can be used for simple dnd transfer and can be useful in many other automated applications.\n\nDemo video: https://www.youtube.com/watch?v=SX8s0wqZ2ks\u0026feature=youtu.be\n\n⚠️ Files placed in the folder will be **uploaded then deleted** ⚠️\n\n## Installation\n\n**1 - Clone \u0026 install repo**\n\n`git clone https://github.com/hmenzagh/reMarkable-Sink \u0026\u0026 cd reMarkable-Sink \u0026\u0026 yarn`\n\n**2 - Install [watchman](https://facebook.github.io/watchman/docs/install.html)**\n\n**3 - Install \u0026 Configure [RmApi](https://github.com/juruen/rmapi)**\n\nDon't forget to run \u0026 set your one-time code !\n\n**4 - Setup .env file**\n\n```bash\nPATH_TO_RMAPI='/Users/hmenzagh/go/bin/rmapi'\nSINK_FOLDER_PATH='/Users/hmenzagh/Desktop/reMarkable-Sink' # Must be an absolute path\nREMARKABLE_FOLDER='Sink' # To create in top-level reMarkable folder\n```\n\n**5 - Do a quick test with `yarn start`**\n\nDone 🎉 \n*(don't forgat to exit the process before setting up daemon)*\n\n## Run at startup\n\n### MacOS\n\n*(Tested on Big Sur)*\n\n**1 - Update `com.remarkable-sink.hmenzagh.plist`**\n\nChange line `:15` to reflect your folder absolute path\n\n**2 - Install [Brew](https://brew.sh)**\n\n*Setup command as of 11/2020*\n\n```bash\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)\"\n```\n\n**3 - Install bash**\n\n```brew install bash```\n\n⚠️ This is needed because of MacOS's **SIP** that prevents reMarkable-Sink from deleting/reading the PDFs properly and causes EPERM errors. The other option is to disable SIP witch is not recommended for most users.\n\n**4 - Install [forever](https://github.com/foreverjs/forever#readme)**\n\n```npm install forever -g```\n\n**5 - Move the plist to Launch LaunchAgents**\n\n```bash\nmv com.remarkable-sink.hmenzagh.plist ~/Library/LaunchAgents/.\n```\n\n6 - Start the daemon\n\n```bash\nlaunchctl load ~/Library/LaunchAgents/com.remarkable-sink.hmenzagh.plist\nlaunchctl start com.remarkable-sink.hmenzagh\n```\nor restart the computer !\n\n*(launchctl load can fail and is a known issue with Big Sur, in this case you should restart)*\n\n### Linux\n\n*(Alternatively you can setup a crontab)*\n\n**1 - Install [PM2](https://github.com/Unitech/pm2)**\n\n`sudo npm install pm2 -g`\n\n**2 - Start reMarkable-Sink**\n\n`pm2 start index.js -n reMarkable-Sink`\n\n**3 - Save setup**\n\n`pm2 save`\n\n**4 - Set at startup**\n\n`sudo pm2 startup` and follow instructions if needed !\n\n## Limitations\n\n- Only accepts PDFs \u003c 50mo\n- The user that executes index.sj needs to be the user that is logged in with RmAPI\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmenzagh%2FreMarkable-Sink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhmenzagh%2FreMarkable-Sink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmenzagh%2FreMarkable-Sink/lists"}