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

**URL:** <https://forum.rclone.org/t/a-fully-typed-typescript-api-client-for-rclones-rc-interface/50528>\
**Category:** Dev Discussions\
**Created:** [March 18, 2025, 7:31pm UTC](https://forum.rclone.org/t/a-fully-typed-typescript-api-client-for-rclones-rc-interface/50528 "2025-03-18T19:31:11Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![CodyAdam](https://forum.rclone.org/user_avatar/forum.rclone.org/codyadam/32/19139_2.png) [@CodyAdam](https://forum.rclone.org/u/CodyAdam)\
**Post date:** [March 18, 2025, 7:31pm UTC](https://forum.rclone.org/t/a-fully-typed-typescript-api-client-for-rclones-rc-interface/50528/1 "2025-03-18T19:31:11Z")

</div>

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.](https://github.com/CodyAdam/rclone-rc)  
Available on npm: [https://www.npmjs.com/package/rclone-rc](https://www.npmjs.com/package/rclone-rc)

Feedback appreciated.

---

<div class="post-metadata">

**Author:** ![CodyAdam](https://forum.rclone.org/user_avatar/forum.rclone.org/codyadam/32/19139_2.png) [@CodyAdam](https://forum.rclone.org/u/CodyAdam)\
**Post date:** [March 19, 2025, 10:22am UTC](https://forum.rclone.org/t/a-fully-typed-typescript-api-client-for-rclones-rc-interface/50528/2 "2025-03-19T10:22:45Z")

</div>

I just added a doc to track progress:

> <https://github.com/CodyAdam/rclone-rc/blob/main/current-status.md>

---

<div class="post-metadata">

**Author:** ![CodyAdam](https://forum.rclone.org/user_avatar/forum.rclone.org/codyadam/32/19139_2.png) [@CodyAdam](https://forum.rclone.org/u/CodyAdam)\
**Post date:** [March 19, 2025, 5:45pm UTC](https://forum.rclone.org/t/a-fully-typed-typescript-api-client-for-rclones-rc-interface/50528/3 "2025-03-19T17:45:25Z")

</div>

**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()`

---

<div class="post-metadata">

**Author:** ![system](https://forum.rclone.org/uploads/default/original/2X/3/39ad3235f6ffec76ccd0c81616bd55697b4c300d.png) [@system](https://forum.rclone.org/u/system)\
**Post date:** [May 21, 2025, 7:01am UTC](https://forum.rclone.org/t/a-fully-typed-typescript-api-client-for-rclones-rc-interface/50528/5 "2025-05-21T07:01:05Z")

</div>

Closed on May 21, 2025, 7:01am UTC

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.
