Skip to content

Commit 6d84e7a

Browse files
committed
docs: add third-party path to How it works diagram
1 parent b5d9e9e commit 6d84e7a

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,16 +75,21 @@ Third-party packages (`user:repo`, `domain.com`) skip the nix store entirely and
7575

7676
```mermaid
7777
flowchart LR
78-
A[onyx install nodejs@22] --> B[Resolve alias]
79-
B --> C[Nixhub API]
80-
C --> D[cache.nixos.org]
81-
D --> E[Install to /nix/store/]
82-
E -->|symlink| F[~/.local/bin/]
78+
A[onyx install pkg] --> B{Third-party?}
79+
B -->|no| C[Resolve alias]
80+
C --> D[Nixhub API]
81+
D --> E[cache.nixos.org]
82+
E --> F[/nix/store/]
83+
B -->|yes| G[Fetch onyx.toml]
84+
G --> H[Download binary]
85+
H --> I[/opt/onyx/packages/]
86+
F -->|symlink| J[~/.local/bin/]
87+
I -->|symlink| J
8388
```
8489

85-
Aliases (`node``nodejs`) are resolved first, then the Nixhub API finds the package, its dependency closure is fetched in parallel from `cache.nixos.org`, unpacked to `/nix/store/`, and symlinked into `~/.local/bin/`.
90+
**Nix packages** — aliases (`node``nodejs`) are resolved first, then the Nixhub API finds the package, its dependency closure is fetched in parallel from `cache.nixos.org`, unpacked to `/nix/store/`, and symlinked into `~/.local/bin/`.
8691

87-
Third-party packages (`user:repo`, `domain.com`) fetch an `onyx.toml` manifest, download the binary for your platform, verify SHA256, and install directly — no nix store involved.
92+
**Third-party packages** (`user:repo`, `domain.com`) fetch an `onyx.toml` manifest, download the binary for your platform, verify SHA256, and install to `/opt/onyx/packages/`.
8893

8994
## Commands
9095

0 commit comments

Comments
 (0)