Skip to content

docs: add Windows quickstart.ps1 instructions to getting-started.md #5668

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
MILTONADINA wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Windows quickstart.ps1 instructions to getting-started.md #5668

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
18 changes: 18 additions & 0 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ This guide will help you set up the Aden Agent Framework and build your first ag

The fastest way to get started:

**Linux / macOS:**

```bash
# 1. Clone the repository
git clone https://github.com/adenhq/hive.git
Expand All @@ -25,6 +27,22 @@ cd hive
uv run python -c "import framework; import aden_tools; print('✓ Setup complete')"
```

**Windows (PowerShell):**

```powershell
# 1. Clone the repository
git clone https://github.com/adenhq/hive.git
cd hive

# 2. Run automated setup
.\quickstart.ps1

# 3. Verify installation (optional, quickstart.ps1 already verifies)
uv run python -c "import framework; import aden_tools; print('Setup complete')"
```

> **Note:** On Windows, running `.\quickstart.ps1` requires PowerShell 5.1+. If you see a "running scripts is disabled" error, run `Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass` first. Alternatively, use WSL — see [environment-setup.md](./environment-setup.md) for details.

## Building Your First Agent

### Option 1: Using Claude Code Skills (Recommended)
Expand Down