Skip to content

docs: add Windows native install guidance #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
liyin2015 wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −3
Open

docs: add Windows native install guidance #123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions docs-site/docs/01-getting-started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,30 @@ Get AdaL running in 2 minutes.
Open any terminal — we recommend iTerm2, cmux, and VS Code terminal. macOS native Terminal requires macOS 26+ for full theme support. For more details, see [Terminal Setup](#terminal-setup).

<Tabs groupId="install-method">
<TabItem value="native" label="Native Install (Recommended)" default>
<TabItem value="mac-linux" label="macOS / Linux / WSL" default>

```bash
curl -fsSL https://adal.sylph.ai/install.sh | bash
```

Native install works on macOS, Linux, and WSL. For other platforms (e.g., Windows PowerShell), use the npm install.
Recommended for macOS, Linux, and Windows users running AdaL inside WSL.

</TabItem>
<TabItem value="windows" label="Windows">

PowerShell:

```powershell
irm https://adal.sylph.ai/install/windows | iex
```

Command Prompt:

```batch
powershell -NoProfile -ExecutionPolicy Bypass -Command "irm https://adal.sylph.ai/install/windows | iex"
```

Run either command to install the native Windows build.

</TabItem>
<TabItem value="npm" label="npm">
Expand All @@ -31,7 +48,7 @@ Native install works on macOS, Linux, and WSL. For other platforms (e.g., Window
npm install -g @sylphai/adal-cli
```

Requires [Node.js 20+](https://nodejs.org/en/download).
Requires [Node.js 20+](https://nodejs.org/en/download). Use npm if you prefer managing AdaL through Node.js.

</TabItem>
</Tabs>
Expand Down