https://github.com/khulnasoft/remote-cache
https://github.com/khulnasoft/remote-cache
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/khulnasoft/remote-cache
- Owner: khulnasoft
- License: mpl-2.0
- Created: 2024-01-25T21:31:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-09T21:31:02.000Z (over 1 year ago)
- Last Synced: 2025-03-04T07:38:26.025Z (7 months ago)
- Language: TypeScript
- Size: 1.06 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Khulnasoft Remote Cache SDK
[](https://github.com/khulnasoft/remote-cache/actions/workflows/ci.yml)
An SDK for Remote Caching on [Khulnasoft](https://khulnasoft.com)
## 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 Khulnasoft'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 Khulnasoft Remote Caching SDK as well as examples of build systems that leverage it. For those looking to integrate their build systems with Khulnasoft Remote Caching, you've come to the right place. The [@khulnasoft/remote SDK](packages/remote/) is a thin layer over our existing [REST API](https://khulnasoft.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 Khulnasoft Remote Cache.
## Examples
Build systems and tools that integrate with Khulnasoft Remote Caching.
- [Turborepo](examples/turborepo)
- [Rush](examples/rush)
- [Nx](examples/nx)
## Packages
| Name | Description | Package |
| ------------------------------------------------ | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
| [@khulnasoft/remote](packages/remote/) | An SDK for remote artifact caching on Khulnasoft | [](https://npmjs.org/@khulnasoft/remote) |
| [@khulnasoft/remote-nx](packages/remote-nx/) | Remote caching plugin for Nx using Khulnasoft Remote Cache | [](https://npmjs.org/@khulnasoft/remote-nx) |
| [@khulnasoft/remote-rush](packages/remote-rush/) | Remote caching plugin for Rush using Khulnasoft Remote Cache | [](https://npmjs.org/@khulnasoft/remote-rush) |
## Contributing
To develop on this package see the [CONTRIBUTING.md](./CONTRIBUTING.md).