{"_id":"@airplanegobrr/rclone-api","name":"@airplanegobrr/rclone-api","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@airplanegobrr/rclone-api","version":"1.0.0","description":"Simple module to interact with the rclone RC REST API.","main":"./dist/index.js","module":"./dist/index.mjs","types":"./dist/index.d.ts","exports":{".":{"import":{"types":"./dist/index.d.mts","default":"./dist/index.mjs"},"require":{"types":"./dist/index.d.ts","default":"./dist/index.js"}}},"scripts":{"build":"tsup","dev":"tsup --watch","typecheck":"tsc --noEmit"},"repository":{"type":"git","url":"git+https://github.com/AirplaneGobrr-Trash/rclone-api.git"},"keywords":["rclone","api","rest","rc","remote-control","backup","sync","wrapper","rclone-api"],"author":{"name":"AirplaneGobrr"},"license":"ISC","dependencies":{"axios":"^1.9.0"},"devDependencies":{"@types/node":"^25.9.1","tsup":"^8.5.1","typescript":"^6.0.3"},"gitHead":"0322d02a6daa0f80bf036c2e5a48e7e4b0cc3a33","_id":"@airplanegobrr/rclone-api@1.0.0","bugs":{"url":"https://github.com/AirplaneGobrr-Trash/rclone-api/issues"},"homepage":"https://github.com/AirplaneGobrr-Trash/rclone-api#readme","_nodeVersion":"24.15.0","_npmVersion":"11.12.1","dist":{"integrity":"sha512-mHU/mSkdaGF3Y8GmDSdnR2KpBS1VtWxKn4WA/vsGNafYtz1j91nLi3ZxvH5FswMOoXKtR2mZpplAEQ+YWYdrrQ==","shasum":"d06feab2b73f71ed8ca30166f094f36af3332521","tarball":"https://registry.npmjs.org/@airplanegobrr/rclone-api/-/rclone-api-1.0.0.tgz","fileCount":8,"unpackedSize":79793,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIH78B4d103H2dsF+dlqbxoVnmsygSPZ4XAZqiGXSQXylAiEA2tTUj+AjbHSfWJ2Kr8DqDQf7TmjZ27ivUtSTfnh3J+A="}]},"_npmUser":{"name":"airplanegobrr","email":"airplanegobrrfeedback@gmail.com"},"directories":{},"maintainers":[{"name":"airplanegobrr","email":"airplanegobrrfeedback@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/rclone-api_1.0.0_1780541455725_0.7071340521069023"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-04T02:50:55.536Z","1.0.0":"2026-06-04T02:50:55.911Z","modified":"2026-06-04T02:50:56.189Z"},"maintainers":[{"name":"airplanegobrr","email":"airplanegobrrfeedback@gmail.com"}],"description":"Simple module to interact with the rclone RC REST API.","homepage":"https://github.com/AirplaneGobrr-Trash/rclone-api#readme","keywords":["rclone","api","rest","rc","remote-control","backup","sync","wrapper","rclone-api"],"repository":{"type":"git","url":"git+https://github.com/AirplaneGobrr-Trash/rclone-api.git"},"author":{"name":"AirplaneGobrr"},"bugs":{"url":"https://github.com/AirplaneGobrr-Trash/rclone-api/issues"},"license":"ISC","readme":"# @airplanegobrr/rclone-api\n\nTypeScript library for interacting with the [rclone RC REST API](https://rclone.org/rc/). Publishes both ESM and CommonJS builds with full type declarations.\n\n## Install\n\n```sh\nbun add @airplanegobrr/rclone-api\n# or\nnpm install @airplanegobrr/rclone-api\n```\n\n## Usage\n\n```ts\nimport { core, operations, sync } from \"@airplanegobrr/rclone-api\";\n\n// CommonJS also works:\n// const { core, operations, sync } = require(\"@airplanegobrr/rclone-api\");\n\nconsole.log(await core.version());\n/* Output:\n{\n  arch: \"386\",\n  decomposed: [ 1, 69, 1 ],\n  goTags: \"cmount\",\n  goVersion: \"go1.24.0\",\n  isBeta: false,\n  isGit: false,\n  linking: \"static\",\n  os: \"windows\",\n  osKernel: \"...\",\n  osVersion: \"...\",\n  osArch: \"386\",\n  version: \"v1.69.1\",\n}\n*/\n\nconsole.log(await operations.list({\n  fs: \"Files:\",\n  remote: \"/testing\",\n  opt: {\n    showHash: true, // Slow! You've been warned.\n  },\n}));\n/* Output:\n{\n  list: [\n    {\n      Path: \"/testing/test.png\",\n      Name: \"test.png\",\n      Size: 32916531,\n      MimeType: \"image/png\",\n      ModTime: \"2025-05-01T13:55:09-07:00\",\n      IsDir: false,\n      Hashes: {\n        md5: \"1d8d451e7101a735b7b6ea68c6d3f201\",\n        sha1: \"00b70f68d99536bb1039c25b6034a3fd5c718367\",\n      }\n    }\n  ],\n}\n*/\n```\n\nEach API section is exposed as its own named export containing the related functions, following the RC docs 1:1 — no abstraction is applied to inputs or outputs.\n\n## Endpoint coverage\n\n`Done ✅` = fully typed inputs and outputs  \n`WIP ⚠️` = implemented, types on inputs/outputs are incomplete\n\n### /core\n\n| URL                  | Status     |\n| -------------------- | ---------- |\n| `/core/bwlimit`      | Done ✅     |\n| `/core/command`      | WIP ⚠️     |\n| `/core/disks`        | Done ✅     |\n| `/core/du`           | Done ✅     |\n| `/core/gc`           | Done ✅     |\n| `/core/group-list`   | WIP ⚠️     |\n| `/core/memstats`     | WIP ⚠️     |\n| `/core/obscure`      | Done ✅     |\n| `/core/pid`          | Done ✅     |\n| `/core/quit`         | Done ✅     |\n| `/core/stats`        | WIP ⚠️     |\n| `/core/stats-delete` | Done ✅     |\n| `/core/stats-reset`  | Done ✅     |\n| `/core/transferred`  | Done ✅     |\n| `/core/version`      | Done ✅     |\n\n### /operations\n\n| URL                          | Status  |\n| ---------------------------- | ------- |\n| `/operations/about`          | WIP ⚠️  |\n| `/operations/check`          | Done ✅  |\n| `/operations/cleanup`        | Done ✅  |\n| `/operations/copyfile`       | Done ✅  |\n| `/operations/copyurl`        | Done ✅  |\n| `/operations/delete`         | Done ✅  |\n| `/operations/deletefile`     | Done ✅  |\n| `/operations/fsinfo`         | Done ✅  |\n| `/operations/hashsum`        | Done ✅  |\n| `/operations/hashsumfile`    | Done ✅  |\n| `/operations/list`           | Done ✅  |\n| `/operations/mkdir`          | Done ✅  |\n| `/operations/movefile`       | Done ✅  |\n| `/operations/publiclink`     | Done ✅  |\n| `/operations/purge`          | Done ✅  |\n| `/operations/rmdir`          | Done ✅  |\n| `/operations/rmdirs`         | Done ✅  |\n| `/operations/settier`        | WIP ⚠️  |\n| `/operations/settierfile`    | WIP ⚠️  |\n| `/operations/size`           | Done ✅  |\n| `/operations/stat`           | Done ✅  |\n| `/operations/uploadfile`     | —       |\n\n> `/operations/uploadfile` requires multipart form data and is not implemented.\n\n### /sync\n\n| URL            | Status  |\n| -------------- | ------- |\n| `/sync/bisync` | Done ✅  |\n| `/sync/copy`   | Done ✅  |\n| `/sync/move`   | Done ✅  |\n| `/sync/sync`   | Done ✅  |\n\n> Note: `bisync` uses `path1`/`path2` parameters, not `srcFs`/`dstFs`.\n\n### Planned modules\n\n- [ ] `/backend`\n- [ ] `/cache`\n- [ ] `/config`\n- [x] `/core`\n- [ ] `/debug`\n- [ ] `/fscache`\n- [ ] `/job`\n- [ ] `/mount`\n- [x] `/operations`\n- [ ] `/options`\n- [ ] `/pluginsctl`\n- [ ] `/rc`\n- [x] `/sync`\n- [ ] `/vfs`\n\n## Build\n\n```sh\nbun run build      # emit dist/ (ESM + CJS + .d.ts)\nbun run dev        # watch mode\nbun run typecheck  # type-check without emitting\n```\n\n## Projects using this\n\n[tt-downloader-v2](https://github.com/AirplaneGobrr-Trash/tt-downloader-v2) by [AirplaneGobrr](https://github.com/AirplaneGobrr)\n","readmeFilename":"README.md","_rev":"1-2f8f63154263b5eeb1d56857c6b91c8a"}