{"id":13771973,"url":"https://github.com/cloudsftp/reSnap","last_synced_at":"2025-05-11T04:31:05.926Z","repository":{"id":40336360,"uuid":"314607971","full_name":"cloudsftp/reSnap","owner":"cloudsftp","description":"Take screnshots of your reMarkable tablet over SSH","archived":false,"fork":false,"pushed_at":"2024-10-15T19:16:32.000Z","size":461,"stargazers_count":54,"open_issues_count":3,"forks_count":10,"subscribers_count":2,"default_branch":"latest","last_synced_at":"2024-11-14T20:07:21.330Z","etag":null,"topics":["remarkable-tablet","ssh"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudsftp.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-20T16:24:20.000Z","updated_at":"2024-10-15T19:16:36.000Z","dependencies_parsed_at":"2023-09-21T21:53:07.637Z","dependency_job_id":"c9947623-0806-4042-9fb3-110010240000","html_url":"https://github.com/cloudsftp/reSnap","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudsftp%2FreSnap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudsftp%2FreSnap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudsftp%2FreSnap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudsftp%2FreSnap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudsftp","download_url":"https://codeload.github.com/cloudsftp/reSnap/tar.gz/refs/heads/latest","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253518941,"owners_count":21921074,"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":["remarkable-tablet","ssh"],"created_at":"2024-08-03T17:00:58.299Z","updated_at":"2025-05-11T04:31:04.409Z","avatar_url":"https://github.com/cloudsftp.png","language":"Shell","funding_links":[],"categories":["Other"],"sub_categories":["Template Builders"],"readme":"# reSnap ![version](https://img.shields.io/badge/version-2.5.1-blue)\n\nreMarkable screenshots over ssh.\n\n[![rm1](https://img.shields.io/badge/reMarkable_1-supported-green)](https://remarkable.com/store/remarkable)\n[![rm2](https://img.shields.io/badge/reMarkable_2-supported-green)](https://remarkable.com/store/remarkable-2)\n[![rm3](https://img.shields.io/badge/reMarkable_Paper_Pro-unsupported-red)](https://remarkable.com/store/remarkable-paper/pro)\n\n![a demo of reSnap](misc/demo.gif)\n\n## Prequisites\n\n- SSH-access to your reMarkable tablet.\n  [Tutorial](https://remarkablewiki.com/tech/ssh) \u003cbr\u003e\n  (recommended: SSH-key so you don't have to type in your root password every time)\n\n- The following programs are required on your computer:\n  - `ffmpeg`\n  - `feh`\n\n\n## Usage\n\n1. Connect your reMarkable via USB\n1. Run\n```\n./reSnap.sh\n```\n\n### Options\n\n- `-s --source` You can specify a custom IP. If you want to use reSnap over the Wifi, specify the IP of your reMarkable here.\n- `-o --output` You can specify a custom output file for reSnap.\n- `-l --landscape` Snapshot has now the landscape orientation.\n- `-d --display` Force program to display the snapshot. (overwrites environment variable)\n- `-n --no-display` Force program to not display the snapshot.\n- `-c --og-color` Turn off color correction (color correction is only active for the reMarkable2)\n- `-p --og-pixel-format` Turns off the byte correction (use this if your reMarkable is on version \u003c 3.6)\n- `-x --clipboard` Copies the result into the clipboard.\n- `-f --sketch` Removes the white background from the result.\n- `-v --version` Displays version.\n- `-h --help` Displays help information.\n\n### Environment Variables\n\n- `REMARKABLE_IP` Default IP of your reMarkable.\n- `RESNAP_DISPLAY` Default behavior of displaying the snapshot. See options `-d` and `-n`.\n- `REMARKABLE_INVERT_COLORS` Default behavior of color inversion. See option `-i`.\n- `RESNAP_COLOR_CORRECTION` Default behavior of color correction on the reMarkable2. See option `-c`.\n- `RESNAP_BYTE_CORRECTION` Default behavior of color correction on the reMarkable2 version \u003e= 3.6. See option `-b`.\n\n`RESNAP_DISPLAY`, `RESNAP_COLOR_CORRECTION` and `RESNAP_BYTE_CORRECTION` are boolean parameters.\nEverything other than `true` is interpreted as `false`!\n\n## Recommended for better performance\n\nIt is recommended to install `lz4` on both your computer and the reMarkable tablet.\n\n### Installing Programs on your reMarkable\n\n#### Manually\n\nCopy the provided binary `lz4.arm.static` to your reMarkable and make it executable.\nThe binary is version `1.9.2`.\n\n```bash\nscp lz4.arm.static root@$REMARKABLE_IP:/home/root/lz4\nssh root@$REMARKABLE_IP 'chmod +x /home/root/lz4'\n```\n\n#### Using Toltec\n\nThis is only recommended for versions up to `2.15.1.1189` at the time of writing.\nYou might brick your reMarkable otherwise!\nCheck for [the warning here](https://toltec-dev.org/#install-toltec).\n\nPlease use [Toltec](https://github.com/toltec-dev/toltec) to install `lz4` on your reMarkable.\n\nPackages:\n- `lz4`\n\nNote: before installing the packages, run\n```\nopkg update\nopkg upgrade\n```\nonce and then install the packages via\n```\nopkg install \u003cpkg\u003e\n```\n\nRemember to run `toltecctl reenable` on your reMarkable tablet after each software update.\n\n### Disclaimer\n\nThe majority of the code is copied from [reStream](https://github.com/rien/reStream). Be sure to check them out!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudsftp%2FreSnap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudsftp%2FreSnap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudsftp%2FreSnap/lists"}