Skip to content

Getting started

Use this guide to stand up the API, submit a run, watch it live, and approve the result.

Install (one command)

The installer checks prerequisites, installs web and .NET dependencies, and launches the dev environment:

bash
# macOS / Linux
curl -fsSL https://raw.githubusercontent.com/sabbour/agentweaver/main/install.sh | bash
powershell
# Windows PowerShell
irm https://raw.githubusercontent.com/sabbour/agentweaver/main/install.ps1 | iex

Both commands will clone the repo to ~/agentweaver if you don't already have a local checkout. If you have already cloned the repo, run bash install.sh (or .\install.ps1) from the repo root instead.

After the installer completes, skip to Configure the API below.


Prerequisites

You need these tools before you start:

  • .NET 10 SDK (global.json pins 10.0.100)
  • Node.js 20.19+ (or 22.12+) — required by Vite 8
  • An existing local Git repository that the agent can target
  • A GitHub account with an active GitHub Copilot subscription — the web UI signs you in via OAuth.
  • A GitHub OAuth App — needed so the API can perform the OAuth sign-in flow. Create one with callback URL http://localhost:5000/auth/github/callback.

1. Configure the API

The API reads settings from appsettings.json plus the environment-specific file for ASPNETCORE_ENVIRONMENT. If you want to use apps/Agentweaver.Api/appsettings.Local.json, set the environment to Local before you start the API.

powershell
$env:ASPNETCORE_ENVIRONMENT = "Local"

Use apps/Agentweaver.Api/appsettings.Local.json to configure your non-secret GitHub OAuth App settings and model provider:

json
{
  "Auth": {
    "GitHub": {
      "ClientId": "<your-oauth-app-client-id>",
      "CallbackUrl": "http://localhost:5000/auth/github/callback",
      "FrontendUrl": "http://localhost:8080"
    }
  },
  "Providers": {
    "GitHubCopilot": {
      "Model": "claude-sonnet-4.6"
    }
  }
}

The ClientId and ClientSecret come from your GitHub OAuth App settings page. CallbackUrl must match the Authorization callback URL registered in the app exactly. Store the client secret with .NET user-secrets, not in appsettings*.json:

powershell
cd apps/Agentweaver.Api
dotnet user-secrets set "Auth:GitHub:ClientSecret" "<your-oauth-app-client-secret>"

2. Start the API

From the repository root, start the backend:

powershell
dotnet run --project apps/Agentweaver.Api

The API listens on the default ASP.NET Core development URL unless you override it through standard host settings.

3. Submit a run from the web UI

Open the web UI to submit runs, watch live events, and review results. Install dependencies and start the Vite dev server:

powershell
cd apps/web
npm install
npm run dev

Set VITE_API_URL in apps/web/.env so the browser client points at your API (default http://localhost:5000), then open the local URL that Vite prints in the console.

dotenv
VITE_API_URL=http://localhost:5000

4. Create a project, run, and review

  1. Sign in with GitHub when the web UI loads.
  2. Create a project from the Project Gallery — blank or cloned from a GitHub repo.
  3. Cast a team (optional) or start straight away.
  4. Start a task from the project Board. The coordinator drafts an OutcomeSpec; confirm it to dispatch work.
  5. Watch the live topology and per-agent execution stream.
  6. Review and merge the assembled diff once the run reaches Human Review — nothing lands on your branch until you approve.

For full end-to-end walkthroughs, see Example walkthroughs.