An open API service indexing awesome lists of open source software.

https://github.com/vercel/remote-cache

The Vercel Remote Cache SDK
https://github.com/vercel/remote-cache

Last synced: 8 months ago
JSON representation

The Vercel Remote Cache SDK

Awesome Lists containing this project

README

          


@vercel/remote-cache
@vercel/remote-cache





# Vercel Remote Cache SDK

[![Node CI](https://github.com/vercel/remote-cache/actions/workflows/ci.yml/badge.svg)](https://github.com/vercel/remote-cache/actions/workflows/ci.yml)

An SDK for Remote Caching on [Vercel](https://vercel.com).

> [!TIP]
> Vercel Remote Cache is now free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache).

## Table of Contents

- [Summary](#summary)
- [Examples](#examples)
- [Packages](#packages)
- [Contributing](#contributing)

## Summary

Remote Computation Caching (or just Remote Caching) is a feature of advanced build tools like [Turborepo](https://turborepo.org/), [Bazel](https://bazel.build/), and [Buck](https://buck.build/) to cache compiled computations and code artifacts in the cloud with the hope of recycling them across machines to reduce overall build/computation time. The key idea is that you "never recompute work that’s already been done before."

> Through Vercel's Remote Caching API, teams can leverage this advanced primitive without needing to think about hosting, infrastructure, or maintenance.

This repository holds the source code to the Vercel Remote Caching SDK as well as examples of build systems that leverage it. For those looking to integrate their build systems with Vercel Remote Caching, you've come to the right place. The [@vercel/remote SDK](packages/remote/) is a thin layer over our existing [REST API](https://vercel.com/docs/rest-api#endpoints/artifacts). We've provided packages that implement this SDK for [Nx](packages/remote-nx/) and [Rush](packages/remote-rush/) build tools. See our [examples list](#examples) of build systems using the Vercel Remote Cache.

## Examples

Build systems and tools that integrate with Vercel Remote Caching.

- [Turborepo](examples/turborepo)
- [Rush](examples/rush)
- [Nx](examples/nx)

## Packages

| Name | Description | Package |
| -------------------------------------------- | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| [@vercel/remote](packages/remote/) | An SDK for remote artifact caching on Vercel | [![@vercel/remote](https://img.shields.io/npm/v/@vercel/remote)](https://npmjs.org/@vercel/remote) |
| [@vercel/remote-nx](packages/remote-nx/) | Remote caching plugin for Nx using Vercel Remote Cache | [![@vercel/remote-nx](https://img.shields.io/npm/v/@vercel/remote-nx)](https://npmjs.org/@vercel/remote-nx) |
| [@vercel/remote-rush](packages/remote-rush/) | Remote caching plugin for Rush using Vercel Remote Cache | [![@vercel/remote-rush](https://img.shields.io/npm/v/@vercel/remote-rush)](https://npmjs.org/@vercel/remote-rush) |

## Contributing

To develop on this package see the [CONTRIBUTING.md](./CONTRIBUTING.md).