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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ dump.rdb
# Temp dirs
tmp

# Dev script logs
.dev-logs/

### PYTHON

# Byte-compiled / optimized / DLL files
Expand Down
30 changes: 28 additions & 2 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,33 @@ The platform integrates with the separate [agentex-python SDK](https://github.co
- Node.js (for frontend)
- uv (Python package manager)

### Quick Start (3-Terminal Setup)
### Quick Start (Recommended)

One command does everything (auto-installs prerequisites if missing):

```bash
./dev.sh # Installs deps + starts backend + frontend
```

> Make sure Docker Desktop or Rancher Desktop is running first.

Other commands:
```bash
./dev.sh stop # Stop all services
./dev.sh status # Check service status
./dev.sh logs # View all logs
./dev.sh restart # Restart all services
```

**Then in a separate terminal - Agent Development:**
```bash
agentex init # Create a new agent
cd your-agent-name/
uv venv && source .venv/bin/activate && uv sync
agentex agents run --manifest manifest.yaml
```

### Manual Setup (Alternative - 3 Terminals)

**Terminal 1 - Backend:**
```bash
Expand All @@ -37,9 +63,9 @@ npm run dev # Starts Next.js dev server

**Terminal 3 - Agent Development:**
```bash
export ENVIRONMENT=development
agentex init # Create a new agent
cd your-agent-name/
uv venv && source .venv/bin/activate && uv sync
agentex agents run --manifest manifest.yaml
```

Expand Down
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,47 @@ To do this, you just need to spin up the [Agentex Server](https://github.com/sca

> Each agent also ships with a `dev.ipynb` notebook for those uninterested in a UI, but more on that later

### Quick Start (Recommended)

Just run one command:

```bash
./dev.sh
```

That's it. This will automatically:
- Install Homebrew, uv, Node.js, and agentex-sdk if missing (macOS)
- Install all backend and frontend dependencies
- Start all Docker services (Postgres, Redis, MongoDB, Temporal)
- Start the backend API and frontend dev server
- Wait for everything to be healthy

> **Note:** Make sure Docker Desktop or Rancher Desktop is running before you start.

Once ready:
| Service | URL |
|---------|-----|
| Frontend UI | http://localhost:3000 |
| Backend API | http://localhost:5003 |
| Swagger Docs | http://localhost:5003/swagger |
| Temporal UI | http://localhost:8080 |

**Other commands:**
```bash
./dev.sh stop # Stop all services
./dev.sh status # Check service status
./dev.sh logs # View all logs
./dev.sh restart # Restart all services
```

Then skip ahead to [Create Your First Agent](#create-your-first-agent).

---

### Manual Setup (Alternative)

If you prefer to run services in separate terminals for more control, follow the steps below.

### Terminal 1 - Agentex Server

First, open up a terminal. Then run the following commands.
Expand Down
Loading