A fully type-safe TypeScript API client for Rclone’s Remote Control (RC) interface, powered by @ts-rest and Zod.
Tested with Rclone v1.70.0
This library is currently under active development. Check out the current status for a list of implemented commands.
Consider contributing if you need a specific command:
- Check
src/api/index.tsfor current implementation - Add your needed command following the same pattern
- Open a Pull Request
- 🔒 Fully Type-Safe: End-to-end type safety for all API calls, including async operations
- 📄 OpenAPI Support: Generated spec for integration with any language/client
- 🧩 Framework Agnostic: Works with any fetch client
- 🚀 Async Operations: First-class support for Rclone’s async operations
- ✅ Runtime Validation: Uses Zod to validate types at runtime
- 💪 HTTP Status Handling: Error responses handled through typed status codes
# Using npm
npm install rclone-rc
# Using yarn
yarn add rclone-rc
# Using pnpm
pnpm add rclone-rc
import { createClient } from 'rclone-rc';
const api = createClient({
baseUrl: 'http://localhost:5572',
username: 'your-username', // Optional if running with --rc-no-auth
password: 'your-password', // Optional if running with --rc-no-auth
});
try {
// Get rclone version with typed response
const { status, body } = await api.version();
if (status === 200) {
console.log('Rclone version:', body.version); // typed
} else if (status === 500) {
console.log('Error:', body.error); // also typed
}
// List files with type-safe parameters and response
const files = await api.list({
body: { fs: 'remote:path', remote: '' }
});
if (files.status === 200) {
console.log('Files:', files.body.list);
}
} catch (error) {
// Only network errors will throw exceptions
console.error('Network error:', error);
}
This library handles errors in two ways:
- HTTP Status Errors: Returned as typed responses with appropriate status codes
- Network Errors: Thrown as exceptions when server is unreachable
For long-running operations:
import { createClient, createAsyncClient } from 'rclone-rc';
const api = createClient({ baseUrl: 'http://localhost:5572' });
const asyncApi = createAsyncClient({ baseUrl: 'http://localhost:5572' });
try {
// Start async job
const job = await asyncApi.list({
body: {
fs: 'remote:path',
remote: '',
_async: true, // You need to pass this flag to the async client
}
});
// Access job ID and check status
const jobId = job.body.jobid;
// Check job status using the non-async client
const status = await api.jobStatus({ body: { jobid: jobId } });
if (status.status === 200 && status.body.finished) {
console.log('Job output:', status.body.output);
}
} catch (error) {
console.error('Network error:', error);
}
Zod validates both request and response types at runtime:
- Request validation: Parameters, body, and query are validated before sending
- Response validation: Can be disabled with
validateResponse: falsein client optionsconst api = createClient({ baseUrl: 'http://localhost:5572', validateResponse: false, // true by default });
Generate an OpenAPI specification for use with other languages and tools:
import { generateOpenApi } from '@ts-rest/open-api';
import { rcloneContract } from 'rclone-rc';
const openApiDocument = generateOpenApi(rcloneContract, {
info: { title: 'Rclone RC API', version: '1.0.0' }
});
Access the raw OpenAPI specifications at:
- https://raw.githubusercontent.com/CodyAdam/rclone-rc/main/openapi.json
- https://raw.githubusercontent.com/CodyAdam/rclone-rc/main/async.openapi.json
pnpm install # Install dependencies
pnpm build # Build the project
pnpm test # Run tests
pnpm lint # Lint code
pnpm format # Format code
pnpm openapi # Generate OpenAPI spec
- Node.js 18+
- TypeScript 5.0+
MIT
https://github.com/CodyAdam/rclone-rc
Leave a Reply