Skip to content

Commit 3f49fc8

Browse files
sdht0prrao87
andauthored
Init nix installation docs (#473)
* Init nix installation docs * Update installation.mdx * Capitalize Nix as per official name --------- Co-authored-by: prrao87 <[email protected]>
1 parent b5b02c2 commit 3f49fc8

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

src/content/docs/installation.mdx

+33-7
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,7 @@ executable with no dependencies that can be used to interact with a Kuzu databas
1616
<Tabs>
1717
<TabItem label="Linux">
1818

19-
Use a tool like cURL to download the latest version of the Kuzu CLI to your local machine. Alternatively,
20-
simply copy-paste [this URL](https://github.com/kuzudb/kuzu/releases/download/v0.9.0/kuzu_cli-linux-x86_64.tar.gz)
21-
for x86-64 or [this one](https://github.com/kuzudb/kuzu/releases/download/v0.9.0/kuzu_cli-linux-aarch64.tar.gz)
22-
for aarch64 into your browser.
19+
Use a tool like cURL to download the latest version of the Kuzu CLI to your local machine.
2320

2421
**x86-64**
2522

@@ -53,7 +50,7 @@ brew install kuzu
5350
<TabItem label="Windows">
5451

5552
Use a tool like cURL to download the latest version of the Kuzu CLI to your local machine. Alternatively,
56-
simply copy-paste [this HTTPS URL](https://github.com/kuzudb/kuzu/releases/download/v0.9.0/kuzu_cli-windows-x86_64.zip)
53+
simply copy-paste [this URL](https://github.com/kuzudb/kuzu/releases/download/v0.9.0/kuzu_cli-windows-x86_64.zip)
5754
into your browser.
5855

5956
```bash
@@ -66,12 +63,33 @@ From within the terminal, you can then run `./kuzu.exe`.
6663

6764
</TabItem>
6865

66+
<TabItem label="Nix">
67+
68+
On Linux, macOS, and WSL2, you can also use [`Nix`](https://nix.dev) to run the Kuzu CLI.
69+
70+
Run Kuzu in a temporary shell:
71+
72+
```bash
73+
nix-shell -p kuzu
74+
kuzu
75+
``````
76+
77+
Alternatively, you can install Kuzu declaratively using Home Manager or NixOS configuration:
78+
79+
```nix
80+
{
81+
environment.systemPackages = [ pkgs.nix ]; // NixOS
82+
home.packages = [ pkgs.nix ]; // Home Manager
83+
}
84+
```
85+
</TabItem>
86+
6987
</Tabs>
7088

7189
## Python
7290

73-
You can use `uv` (recommended) or `pip` to install the Kuzu Python client library.
74-
The instructions are the same for macOS, Linux, and Windows.
91+
You can use `uv`, `pip`, or `nix` to install the Kuzu Python client library.
92+
The instructions are the same for Linux, macOS, and Windows.
7593

7694
<Tabs>
7795

@@ -92,6 +110,14 @@ pip install kuzu
92110

93111
</TabItem>
94112

113+
<TabItem label="nix">
114+
115+
```bash
116+
nix-shell -p "python3.withPackages (ps: [ ps.kuzu ])"
117+
```
118+
119+
</TabItem>
120+
95121
</Tabs>
96122

97123
## Node.js

0 commit comments

Comments
 (0)