https://github.com/cachix/cachix
Command line client for Nix binary cache hosting:
https://github.com/cachix/cachix
dhall haskell nix nixos servant
Last synced: 20 days ago
JSON representation
Command line client for Nix binary cache hosting:
- Host: GitHub
- URL: https://github.com/cachix/cachix
- Owner: cachix
- Created: 2018-02-25T19:55:01.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-15T13:42:29.000Z (about 2 months ago)
- Last Synced: 2025-04-04T20:12:47.792Z (26 days ago)
- Topics: dhall, haskell, nix, nixos, servant
- Language: Haskell
- Homepage: https://cachix.org
- Size: 3.4 MB
- Stars: 887
- Watchers: 11
- Forks: 48
- Open Issues: 123
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - cachix/cachix - Command line client for Nix binary cache hosting: (Haskell)
- awesome-starred - cachix/cachix - Command line client for Nix binary cache hosting: (Haskell)
README
## [Cachix](https://cachix.org) - Nix binary cache hosting: Never build software twice.
[](https://github.com/cachix/cachix/actions)
[](https://hackage.haskell.org/package/cachix)
```
$ cachix --help
https://cachix.org command line interface
Usage: cachix [-c|--config CONFIGPATH] [--host URI | --hostname URI]
[-v|--verbose] (COMMAND | (-V|--version))
To get started, log in to https://app.cachix.org
Available options:
-h,--help Show this help text
-c,--config CONFIGPATH Cachix configuration file
(default: "/home/sandydoo/.config/cachix/cachix.dhall")
--hostname URI Host to connect to (default: https://cachix.org)
-v,--verbose Verbose mode
-V,--version Show cachix version
Config commands:
authtoken Configure an authentication token for Cachix
config Manage configuration settings for cachix
Cache commands:
generate-keypair Generate a signing key pair for a binary cache
use Configure a binary cache in nix.conf
remove Remove a binary cache from nix.conf
Push commands:
push Upload Nix store paths to a binary cache
watch-exec Run a command while watching /nix/store for newly
added store paths and upload them to a binary cache
watch-store Watch /nix/store for newly added store paths and
upload them to a binary cache
import Import the contents of a binary cache from an
S3-compatible object storage service into Cachix
Store path commands:
pin Pin a store path to prevent it from being garbage
collected
Daemon commands:
daemon Run a daemon that listens to push requests over a
unix socket
Cachix Deploy commands:
deploy Manage remote Nix-based systems with Cachix Deploy
```
## Installation
1. Install the Cachix client using Nix:
```bash
nix-env -iA cachix -f https://cachix.org/api/v1/install
```
Also available as `pkgs.cachix` in [nixpkgs](https://github.com/NixOS/nixpkgs).
2. Login via https://www.cachix.org/api/v1/login to start using the service
## Development
Install Cachix from master:
```bash
nix-env -if https://github.com/cachix/cachix/tarball/master --substituters 'https://cache.nixos.org https://cachix.cachix.org' --trusted-public-keys 'cachix.cachix.org-1:eWNHQldwUO7G2VkjpnjDbWwy4KQ/HNxht7H4SSoMckM= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY='
```
Or with Nix 2.4+:
```bash
nix profile install github:cachix/cachix/latest --accept-flake-config
```
## Support
- [Documentation](https://docs.cachix.org)
- [#[email protected]](https://matrix.to/#/#cachix:matrix.org)
- [Discord](https://discord.com/invite/naMgvexb6q)
- [[email protected]](mailto:[email protected])
## Changelog
- [Cachix changelog](./cachix/CHANGELOG.md) for the command
- [API changelog](./cachix-api/CHANGELOG.md) (Haskell)