A fully typed TypeScript API client for Rclone's RC interface

CodyAdam · March 18, 2025, 7:31pm

For my personal project, I needed to heavily rely on rclone for remote use, but I couldn't find a well-documented REST API for it.
I know there have been discussions on the forum, but nothing concrete.

So, I started working on an rclone API with fully type-safe responses, compatible with the OpenAPI spec.

GitHub (MIT license): GitHub - CodyAdam/rclone-rc: A fully typed TypeScript API client for rclone's Remote Control (RC) interface.
Available on npm: https://www.npmjs.com/package/rclone-rc

Feedback appreciated.

CodyAdam · March 19, 2025, 10:22am

I just added a doc to track progress:

github.com/CodyAdam/rclone-rc

current-status.md

main



# Current completed endpoints

Percentage complete: 17.24% (15/87)

| Endpoint | Implemented | Alias | Description |
|----------|-------------|-------|-------------|
| backend/command | ❌ |  | Runs a backend command. |
| config/create | ❌ |  | create the config for a remote. |
| config/delete | ❌ |  | Delete a remote in the config file. |
| config/dump | ❌ |  | Dumps the config file. |
| config/get | ❌ |  | Get a remote in the config file. |
| config/listremotes | ❌ |  | Lists the remotes in the config file and defined in environment variables. |
| config/password | ❌ |  | password the config for a remote. |
| config/paths | ❌ |  | Reads the config file path and other important paths. |
| config/providers | ❌ |  | Shows how providers are configured in the config file. |
| config/setpath | ❌ |  | Set the path of the config file |
| config/update | ❌ |  | update the config for a remote. |
| core/bwlimit | ❌ |  | Set the bandwidth limit. |

This file has been truncated. show original

CodyAdam · March 19, 2025, 5:45pm

All major operations are implemented and tested!

Implemented Features (20/87 endpoints - 22.99%)

Core Operations

api.stats(), api.version()

Job Management

api.jobList(), api.jobStatus(), api.jobStop(), api.jobStopGroup()

File Operations

api.about(), api.check(), api.list(), api.mkdir()
api.purge(), api.rmdir(), api.uploadFile()

Sync Operations

api.bisync(), api.copy(), api.move(), api.sync()

Configuration & Utilities

api.optionsLocal(), api.noop(), api.noopAuth()