Skip to content

Commit d9bdce0

Browse files
committed
docs: update CLI installation instructions for Probitas 0.6.0+
- Add shell installer as the primary installation method - Update Nix flake path from jsr-probitas/probitas to jsr-probitas/cli - Remove deprecated `probitas init` command section - Keep deno install as alternative method
1 parent 2f1b373 commit d9bdce0

2 files changed

Lines changed: 47 additions & 26 deletions

File tree

deno.lock

Lines changed: 27 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/overview.md

Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -30,33 +30,40 @@ Add Probitas to your project's `deno.json`:
3030

3131
### Install CLI
3232

33-
Install the CLI to run scenarios:
33+
Install the CLI to run scenarios using the shell installer:
3434

3535
```bash
36-
deno install -grAf -n probitas jsr:@probitas/cli
36+
curl -fsSL https://raw.githubusercontent.com/jsr-probitas/cli/main/install.sh | bash
3737
```
3838

39-
- `-g` Global install
40-
- `-r` Reload cache (fetch latest version)
41-
- `-A` All permissions
42-
- `-f` Force overwrite existing
43-
- `-n probitas` Command name
39+
**Options via environment variables:**
40+
41+
```bash
42+
# Install specific version
43+
curl -fsSL https://raw.githubusercontent.com/jsr-probitas/cli/main/install.sh | PROBITAS_VERSION=0.7.1 bash
44+
45+
# Install to custom directory
46+
curl -fsSL https://raw.githubusercontent.com/jsr-probitas/cli/main/install.sh | PROBITAS_INSTALL_DIR=/usr/local/bin bash
47+
```
48+
49+
Alternatively, install via Deno:
50+
51+
```bash
52+
deno install -grAf -n probitas jsr:@probitas/cli
53+
```
4454

4555
### Using Nix
4656

47-
Use the flake to run or install the CLI without Deno-level globals:
57+
Use the flake to run or install the CLI:
4858

4959
```bash
5060
# Run without installing
51-
nix run github:jsr-probitas/probitas
61+
nix run github:jsr-probitas/cli
5262

5363
# Install into your profile
54-
nix profile install github:jsr-probitas/probitas#probitas
64+
nix profile install github:jsr-probitas/cli
5565
```
5666

57-
The flake packages a wrapper that runs the bundled CLI with the repository
58-
import map and lockfile.
59-
6067
## Quick Start
6168

6269
```typescript
@@ -93,19 +100,6 @@ src/
93100

94101
## Running Scenarios
95102

96-
### Initialize a Project
97-
98-
```bash
99-
probitas init
100-
```
101-
102-
This creates:
103-
104-
- deno.json - Configuration with probitas import and settings
105-
- probitas/example.probitas.ts - Example scenario
106-
107-
### Run Scenarios
108-
109103
```bash
110104
# Run all scenarios
111105
probitas run

0 commit comments

Comments
 (0)