Skip to content
This repository was archived by the owner on Dec 27, 2025. It is now read-only.

Commit ebc2e44

Browse files
committed
docs: add Nix installation and development instructions
Document how to use Nix flake for installation (nix run, nix profile install) and development (nix develop). Reorganize Installation and Development sections with clear subsections.
1 parent 5d0b61b commit ebc2e44

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Command-line interface for
66

77
## Installation
88

9+
### Using install script
10+
911
```bash
1012
curl -fsSL https://raw.githubusercontent.com/jsr-probitas/cli/main/install.sh | bash
1113
```
@@ -20,6 +22,23 @@ curl -fsSL https://raw.githubusercontent.com/jsr-probitas/cli/main/install.sh |
2022
curl -fsSL https://raw.githubusercontent.com/jsr-probitas/cli/main/install.sh | PROBITAS_INSTALL_DIR=/usr/local/bin bash
2123
```
2224

25+
### Using Nix
26+
27+
With [Nix](https://nixos.org/) and flakes enabled:
28+
29+
```bash
30+
# Run directly without installing
31+
nix run github:jsr-probitas/cli
32+
33+
# Install to profile
34+
nix profile install github:jsr-probitas/cli
35+
36+
# Use in a flake (flake.nix)
37+
{
38+
inputs.probitas-cli.url = "github:jsr-probitas/cli";
39+
}
40+
```
41+
2342
## Usage
2443

2544
```bash
@@ -99,6 +118,20 @@ Create a `probitas.json` file in your project root:
99118

100119
## Development
101120

121+
### Using Nix (recommended)
122+
123+
```bash
124+
# Enter development shell with all dependencies
125+
nix develop
126+
127+
# Or run commands directly
128+
nix develop -c deno task test
129+
```
130+
131+
### Without Nix
132+
133+
Requires [Deno](https://deno.land/) v2.x or later.
134+
102135
```bash
103136
# Run tests
104137
deno task test

0 commit comments

Comments
 (0)