You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/01-Getting-Started/2-Installation.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,30 @@
1
-
##Installation
1
+
# Installation
2
2
3
-
###Requirements
3
+
## Requirements
4
4
5
5
**kool** is powered by **Docker**. To use **kool**, you need to **[install the Docker Engine and Docker Compose](https://docs.docker.com/get-docker/)** on your local machine, and make sure they're both running.
6
6
7
7
Important to notice: `kool` relies on the `docker` and `docker compose` CLI commands - that being said, you can pick any other Docker-compatibable container engine and use it seamlessly, like OrbStack for example.
8
8
9
9
> `kool` now requires [Docker Compose V2](https://docs.docker.com/compose/install/), make sure you have it enabled in your system.
10
10
11
-
###For Linux and macOS
11
+
## For Linux and macOS
12
12
13
13
Install **kool** by running the following script. It will download the latest **kool** binary from [https://github.com/kool-dev/kool/releases](https://github.com/kool-dev/kool/releases), and save it in your `/usr/local/bin` folder.
14
14
15
15
```bash
16
16
$ curl -fsSL https://kool.dev/install | bash
17
17
```
18
18
19
-
###For Windows
19
+
## For Windows
20
20
21
21
You must run `kool` on Windows via [WSL - Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install) - once you have a WSL environment properly set up, make sure you have [Docker available on it](https://docs.docker.com/desktop/wsl/), then you can install the CLI as you would in any Linux or MacOS (see above).
22
22
23
23
### Verification
24
24
25
25
Verify **kool** is installed correctly by running `kool` in your terminal to see a list of available commands.
26
26
27
-
##Stay Up-to-Date
27
+
# Stay Up-to-Date
28
28
29
29
Update **kool** to a newer version using the `self-update` command. This command will compare your local version with the latest release, and, if a newer version is available, automatically download and install it.
30
30
@@ -34,11 +34,11 @@ $ kool self-update
34
34
35
35
> Sign up for new release notifications and stay up-to-date on our latest features! [Go to our main GitHub repository](https://github.com/kool-dev/kool), click on "Watch" at the top, select the "Custom" option, check "Releases", and hit Apply.
36
36
37
-
##Autocompletion
37
+
# Autocompletion
38
38
39
39
If you want to use **kool** autocompletion in your Unix shell, follow the appropriate instructions below.
40
40
41
-
###Bash
41
+
## Bash
42
42
43
43
Temporarily enable autocompletion for your **current session only**:
44
44
@@ -62,7 +62,7 @@ $ kool completion bash > /usr/local/etc/bash_completion.d/kool
62
62
63
63
> After running one of the above commands, remember to start a new shell for autocompletion to take effect.
64
64
65
-
###Zsh
65
+
## Zsh
66
66
67
67
If Zsh tab completion is not already initialized on your machine, run the following command to turn it on.
68
68
@@ -78,7 +78,7 @@ $ kool completion zsh > "${fpath[1]}/_kool"
78
78
79
79
> After running the above command, remember to start a new shell for autocompletion to take effect.
80
80
81
-
###Fish
81
+
## Fish
82
82
83
83
Temporarily enable autocompletion for your **current session only**:
0 commit comments