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: README.md
+42-25Lines changed: 42 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,8 @@ Each lifted slash command spawns a managed backend child agent in the active pro
20
20
21
21
## Install
22
22
23
+
If you want the fastest path, `https://morph.new/opengauss` launches the hosted setup in under 10 seconds. The local installers below are the batteries-included path for your own machine and can take up to 10 minutes.
24
+
23
25
### macOS and Linux
24
26
25
27
```bash
@@ -28,36 +30,58 @@ cd OpenGauss
28
30
./scripts/install.sh
29
31
```
30
32
31
-
The installer will:
33
+
This is the canonical local install path. It bootstraps the local installer runtime, runs the shared `opengauss` installer flow on your machine, and then auto-attaches to the final `gauss` tmux session when possible.
34
+
35
+
It will:
32
36
33
-
1. Install system dependencies (via Homebrew on macOS, apt on Ubuntu/Debian)
34
-
2. Install `uv`, Node.js, Claude Code, and the Lean toolchain if missing
35
-
3. Create a Python virtualenv and install Gauss
36
-
4. Link the `gauss` command to `~/.local/bin/gauss`
37
-
5. Set up `~/.gauss/` for runtime config and secrets
38
-
6. Auto-configure the main provider/model from staged keys when possible
37
+
1. Install `uv` if needed
38
+
2. Create a repo-local installer environment
39
+
3. Install or upgrade the local runner
40
+
4. Run the shared `opengauss` installer flow on your machine
41
+
5. Auto-attach you to the local `gauss` tmux session when possible, or print the exact `tmux attach -t gauss` command if not
39
42
40
-
`~/.local/bin/gauss` is ready immediately after install. To use plain `gauss` in the same terminal, reload your shell first:
43
+
You can pass normal template-runner flags through to the alternate script, for example:
Run `gauss setup` later if you want to review or change the selected provider, model, or other settings.
51
+
### Windows (via WSL2)
49
52
50
-
If you prefer Gauss to create a prewarmed Lean workspace during install:
53
+
Open Gauss on Windows runs through WSL2 using the same shared installer flow.
51
54
52
-
```bash
53
-
./scripts/install.sh --with-workspace
55
+
From PowerShell:
56
+
57
+
```powershell
58
+
.\scripts\install.ps1 -WithWorkspace
54
59
```
55
60
56
-
Otherwise, after install just start Gauss:
61
+
This bootstrap:
62
+
63
+
1. Starts your WSL distro
64
+
2. Clones or updates `OpenGauss` inside your WSL home directory
65
+
3. Runs `./scripts/install.sh` there, which executes the shared `opengauss` installer flow inside WSL
66
+
67
+
If no WSL distro is initialized yet, the bootstrap will install Ubuntu for you with `wsl --install -d Ubuntu`. If that process drops you into the new Linux shell, type `exit` to return to PowerShell and rerun `.\scripts\install.ps1 -WithWorkspace`. Windows may also ask to enable WSL features or restart before you rerun the installer.
0 commit comments