Shinonome/caelestia-cli
1
0
Fork 1
mirror of https://github.com/caelestia-dots/cli.git synced 2026-06-05 14:59:29 -05:00
Code Issues Packages Projects Releases Wiki Activity

readme: update installation section

Browse Source 
Add stable/unstable packages + nix
This commit is contained in:
2 * r + 2 * t
2025-09-14 00:03:22 +10:00
parent 54f7611437
commit 6f8e5849cb
1 changed files with 40 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+40 -6
View File
@@ -20,18 +20,52 @@ The main control script for the Caelestia dotfiles.
## Installation ## Installation
### Package manager (recommended) ### Arch linux
The cli is available from the AUR as `caelestia-cli-git`. To install it you can use The CLI is available from the AUR as `caelestia-cli`. You can install it with an AUR helper
an AUR helper like [`yay`](https://github.com/Jguer/yay), or manually download the like [`yay`](https://github.com/Jguer/yay) or manually downloading the PKGBUILD and running `makepkg -si`.
PKGBUILD and run `makepkg -si`.
e.g. using yay A package following the latest commit also exists as `caelestia-cli-git`. This is bleeding edge
and likely to be unstable/have bugs. Regular users are recommended to use the stable package
(`caelestia-cli`).
### Nix
You can run the CLI directly via `nix run`:
```sh ```sh
yay -S caelestia-cli-git nix run github:caelestia-dots/cli
``` ```
Or add it to your system configuration:
```nix
{
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
caelestia-cli = {
url = "github:caelestia-dots/cli";
inputs.nixpkgs.follows = "nixpkgs";
};
};
}
```
The package is available as `caelestia-cli.packages.<system>.default`, which can be added to your
`environment.systemPackages`, `users.users.<username>.packages`, `home.packages` if using home-manager,
or a devshell. The CLI can then be used via the `caelestia` command.
> [!TIP]
> The default package does not have the shell enabled by default, which is required for full functionality.
> To enable the shell, use the `with-shell` package. This is the recommended installation method, as
> the CLI exposes the shell via the `shell` subcommand, meaning there is no need for the shell package
> to be exposed.
For home-manager, you can also use the Caelestia's home manager module (explained in
[configuring](https://github.com/caelestia-dots/shell?tab=readme-ov-file#home-manager-module)) that
installs and configures the shell and the CLI.
### Manual installation ### Manual installation
Install all [dependencies](#dependencies), then install Install all [dependencies](#dependencies), then install