Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 27 additions & 0 deletions FIXES_APPLIED.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Fixes Applied to Aden Hive

This document lists the fixes that were applied to address the identified issues.

## Issues Identified & Fixes Applied:

### 1. **uv Installation** (`README.md` and `docs/getting-started.md`)
- **Issue**: Users try to run `./quickstart.sh` but `uv` is not installed
- **Fix**: Added `pip install uv` instruction before cloning and running quickstart

### 2. **Windows Quickstart** (`README.md` and `docs/getting-started.md`)
- **Issue**: No clear Windows instructions - users try to run `./quickstart.sh` on Windows
- **Fix**: Added Windows-specific section showing `.\quickstart.ps1` in PowerShell

### 3. **TUI Deprecation** (`docs/getting-started.md`)
- **Issue**: Shows `hive tui` commands but TUI is deprecated (per AGENTS.md)
- **Fix**: Added deprecation notice in Next Steps section recommending `hive open` instead

---

## Summary:
Apply these fixes to your local copy and submit as a PR to demonstrate understanding of the codebase and attention to detail.

## Files Modified:
1. `README.md` - Added uv installation and Windows quickstart instructions
2. `docs/getting-started.md` - Added uv installation, Windows quickstart, and TUI deprecation notice

9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,18 @@ Use Hive when you need:
> Please use the quickstart script below to set up the environment.

```bash
# Install uv first (required)
pip install uv

# Clone the repository
git clone https://github.com/aden-hive/hive.git
cd hive


# Run quickstart setup
# Run quickstart setup (Linux/macOS)
./quickstart.sh

# On Windows, use PowerShell instead:
# .\quickstart.ps1
```

This sets up:
Expand Down
11 changes: 10 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,20 @@ This guide will help you set up the Aden Agent Framework and build your first ag
The fastest way to get started:

```bash
# Install uv first (required)
pip install uv

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

# 2. Run automated setup
# On Linux/macOS:
./quickstart.sh

# On Windows (PowerShell):
# .\quickstart.ps1

# 3. Verify installation (optional, quickstart.sh already verifies)
uv run python -c "import framework; import aden_tools; print('✓ Setup complete')"
```
Expand Down Expand Up @@ -181,13 +188,15 @@ PYTHONPATH=exports uv run python -m my_agent test --type success

## Next Steps

1. **Dashboard**: Run `hive open` to launch the web dashboard, or `hive tui` for the terminal UI
1. **Dashboard**: Run `hive open` to launch the web dashboard (recommended)
2. **Detailed Setup**: See [environment-setup.md](./environment-setup.md)
3. **Developer Guide**: See [developer-guide.md](./developer-guide.md)
4. **Build Agents**: Use `/hive` skill in Claude Code
5. **Custom Tools**: Learn to integrate MCP servers
6. **Join Community**: [Discord](https://discord.com/invite/MXE49hrKDk)

> **Note:** The TUI (`hive tui`) is deprecated. Use `hive open` for the web dashboard instead.

## Troubleshooting

### ModuleNotFoundError: No module named 'framework'
Expand Down