{"repo":"erikbrinkman/rmapi-js","free":true,"listed":false,"github":"https://github.com/erikbrinkman/rmapi-js","clone":"git clone https://github.com/erikbrinkman/rmapi-js.git","description":"JavaScript implementation of the reMarkable api","language":"TypeScript","stars":75,"topics":["remarkable-tablet","typescript","api-client","cloud-api","epub","javascript","pdf","remarkable"],"license":"MIT","category":"media-processing","readme_excerpt":"rmapi-js JavaScript implementation of the reMarkable api. It should also be pretty easy to customize to work with rmfakecloud, although that might take a little bit of extra plumbing. API Before using this API it's necessary to have some rudimentary understanding of how the API works. All data is stored via its sha256 hash. This includes raw files (\"documents\") and folders (\"collections\"). The hash indicates the full current state to manage simultaneous edits. Most entries or edits will take an input hash, and return an output hash. Additionally, every entry has an id, which is a uuid4, and remains constantant over the lifetime of the file or folder. There are two special ids, \"\" (the empty string) which corresponds to the root collection, e.g. the default location for all files, and \"trash\", which is the trash. Usage To explore files in the cloud, you need to first register your api and persist the token. Then you can use listItems to explore entries of different file collections. auth performs the same network call that remarkable does for you internally, returning a short-lived session token. session is synchronous, letting you construct clients from cached tokens without making a network call. To upload an epub or pdf, simply call upload with the appropriate name and buffer. There are alos low level apis that more directly manipulate cloud storage. Using these apis is a little riskier since they can potentially result in data loss, but it does come with increased flexibil","default_branch":null,"files":null,"tree":[],"storefront":"/r/erikbrinkman","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/erikbrinkman/rmapi-js/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}