https://github.com/boringcache/cli
Content-addressed artifact cache for CI, Docker, and local dev.
https://github.com/boringcache/cli
caching ci cicd dependency-management utilities
Last synced: about 1 month ago
JSON representation
Content-addressed artifact cache for CI, Docker, and local dev.
- Host: GitHub
- URL: https://github.com/boringcache/cli
- Owner: boringcache
- License: other
- Created: 2025-09-03T16:35:35.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-04-14T09:57:13.000Z (2 months ago)
- Last Synced: 2026-04-14T10:27:25.839Z (2 months ago)
- Topics: caching, ci, cicd, dependency-management, utilities
- Language: Rust
- Homepage: https://boringcache.com
- Size: 1.61 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# BoringCache CLI
BoringCache is a shared build cache for CI, Docker builds, and local development.
If you are new here, start in the terminal:
```bash
curl -sSL https://install.boringcache.com/install.sh | sh
cd your-project
boringcache onboard
```
`boringcache onboard` authenticates the CLI, chooses a workspace, writes `.boringcache.toml` when it can, and lines up the same cache names across local runs, Docker builds, and GitHub Actions.
If you want to start sign-in from the terminal by email, use `boringcache onboard --email you@example.com`. For a brand-new account, pass `--name` and `--username` too.
Repo config can also keep the repeated command itself under `[adapters.]`.
`command` accepts either an argv array or a shell-style string.
This is not general TOML templating: proxy-backed commands only substitute `{PORT}`, `{ENDPOINT}`, and `{CACHE_REF}`.
After that, start with the shortest command that fits the tool:
```bash
# Archive mode (run/save/restore)
boringcache run -- bundle install
# Docker adapter from repo config
boringcache docker
# Same adapter without repo config
boringcache docker --tag docker-cache -- docker buildx build .
# Long-lived local proxy
boringcache cache-registry my-org/app registry-cache --port 5000
```
Use archive mode commands (`run`, `save`, and `restore`) when you are caching explicit directories.
Use adapter commands when the build tool already speaks a remote-cache protocol and BoringCache has a dedicated wrapper for it.
Use `cache-registry` when the repo already has a checked-in local endpoint setup or another process should keep the proxy alive. `cache-registry` is the proxy. `run --proxy` and adapter commands temporarily start that same proxy for one command.
When `.boringcache.toml` stores the Docker command, `boringcache docker` is the short form. Use the longer version when you want to pass the Docker command inline.
If you are wiring GitHub Actions, use [`boringcache/one@v1`](https://github.com/boringcache/one) after onboard so CI can reuse the same repo config and trust model.
## Docs
- [Quick start](docs/quick-start.md)
- [Onboard](docs/onboard.md)
- [Archive mode](docs/archive-mode.md)
- [Adapter commands](docs/adapter-commands.md)
- [Tool guides](docs/tool-guides.md)
- [Proxy mode](docs/proxy-mode.md)
- [GitHub Actions](docs/github-actions.md)
- [Development](docs/development.md)
- [Installation setup](INSTALLATION.md)
- [Website docs](https://boringcache.com/docs)