Skip to content

Commit 869b3d3

Browse files
committed
docs: added instruction to use custom installation path
1 parent 0ef3a61 commit 869b3d3

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

docs/getting-started.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Installation
22

3-
We provide two versions of Context Generator:
4-
- a native binary
5-
- a PHAR file.
3+
We provide two versions of Context Generator:
64

7-
The native binary is the recommended version, because it does not require PHP to be installed on your system. You can
8-
use it on Linux and MacOS.
5+
- a native binary
6+
- a PHAR file.
7+
8+
The native binary is the recommended version, because it does not require PHP to be installed on your system. You can
9+
use it on Linux and MacOS.
910

1011
The PHAR file can be used on any system with PHP 8.2 or higher.
1112

@@ -30,6 +31,26 @@ curl -sSL https://raw.githubusercontent.com/context-hub/generator/main/download-
3031
- Installs it (`ctx`) to your bin directory (default: `/usr/local/bin`)
3132
- Makes it executable
3233

34+
<br>
35+
36+
If you install to a system directory like `/usr/local/bin`, you probably need `sudo`:
37+
38+
```bash
39+
curl -sSL https://raw.githubusercontent.com/context-hub/generator/main/download-latest.sh | sudo sh
40+
```
41+
42+
Install to a custom path to avoid using `sudo`:
43+
44+
```bash
45+
curl -sSL https://raw.githubusercontent.com/context-hub/generator/main/download-latest.sh | sh -s $HOME/.local/bin
46+
```
47+
48+
<br>
49+
50+
---
51+
52+
<br>
53+
3354
After installation, you can use it by simply running the command to generate context:
3455

3556
```bash

0 commit comments

Comments
 (0)