Skip to content
Merged
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
53 changes: 53 additions & 0 deletions .github/workflows/install-script.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Install script

on:
pull_request:
paths:
- scripts/install.sh
- scripts/get.xagent.co/**
- .github/workflows/install-script.yml
push:
branches: [main]
paths:
- scripts/install.sh
- scripts/get.xagent.co/**
- .github/workflows/install-script.yml
Comment thread
qinxuye marked this conversation as resolved.
workflow_dispatch:

jobs:
lint:
Comment thread
qinxuye marked this conversation as resolved.
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: "22" # node --test needs >=18; AbortSignal.timeout needs >=17.3
- name: ShellCheck
run: shellcheck scripts/install.sh # pre-installed on ubuntu runners
- name: Test the get.xagent.co worker
working-directory: scripts/get.xagent.co
run: |
node --check worker.js # ES module (package.json sets "type": "module")
node --test

smoke:
# Actually run the one-liner end to end so it can't silently rot.
needs: lint
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- name: Run installer and verify the command works
env:
# Isolate the tool install so the runner's env stays clean and we
# control where the `xagent` entry point lands.
UV_TOOL_BIN_DIR: ${{ runner.temp }}/xagent-bin
run: |
set -eu
sh scripts/install.sh
export PATH="$UV_TOOL_BIN_DIR:$PATH"
command -v xagent
xagent --help
28 changes: 28 additions & 0 deletions scripts/get.xagent.co/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# get.xagent.co

Cloudflare Worker that serves [`scripts/install.sh`](../install.sh) so users can install Xagent with:

```bash
curl -fsSL https://get.xagent.co | sh
```

The Worker serves the installer pinned to the **latest GitHub release tag**, so the public one-liner only ever runs a shipped, immutable version. It **fails closed**: if the release can't be resolved, or that tag doesn't contain the script, it returns `502` instead of falling back to a floating ref like `main` — a public `curl | sh` endpoint must never serve unreleased code.

> The endpoint only works once a release that includes `scripts/install.sh` exists. Cut a release after this lands to bring it online.

## Deploy

Requires [`wrangler`](https://developers.cloudflare.com/workers/wrangler/) and access to the Cloudflare account that owns the `xagent.co` zone.

```bash
cd scripts/get.xagent.co
wrangler deploy
```

Then map `get.xagent.co` to this Worker (the `routes` entry in `wrangler.toml` does this once the zone is on the account).

## Notes

- The Worker only serves the script; it runs no user code.
- Edge-caches the resolved script for 5 minutes (`CACHE_TTL_SECONDS`).
- To publish a change to the installer: merge it to `main`, then cut a release — the endpoint serves the latest release tag, so changes go live only once released.
4 changes: 4 additions & 0 deletions scripts/get.xagent.co/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"private": true,
"type": "module"
}
85 changes: 85 additions & 0 deletions scripts/get.xagent.co/worker.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
// Cloudflare Worker backing https://get.xagent.co
//
// Serves scripts/install.sh from the xagent repo so users can run:
//
// curl -fsSL https://get.xagent.co | sh
//
// The script is pinned to the latest GitHub *release tag*, so the public
// one-liner only ever serves a shipped, immutable version. It fails closed:
// if the release can't be resolved or the tag doesn't contain the script, it
// returns 502 rather than falling back to a floating ref like `main` — a public
// `curl | sh` endpoint must never serve unreleased code. (This means the
// endpoint only works once a release that includes scripts/install.sh exists.)
// Deploy with `wrangler deploy`.

const REPO = "xorbitsai/xagent";
const SCRIPT_PATH = "scripts/install.sh";
// Cache the resolved script at the edge to avoid hitting GitHub on every hit.
const CACHE_TTL_SECONDS = 300;

async function latestReleaseTag() {
// Never throw: on any API failure return null so the caller fails closed.
try {
const res = await fetch(`https://github.com/@api/repos/${REPO}/releases/latest`, {
Comment thread
qinxuye marked this conversation as resolved.
headers: { "User-Agent": "get.xagent.co", Accept: "application/vnd.github+json" },
cf: { cacheTtl: CACHE_TTL_SECONDS, cacheEverything: true },
signal: AbortSignal.timeout(5000), // don't hang the client on a stuck upstream
});
if (!res.ok) return null;
const data = await res.json();
return typeof data.tag_name === "string" && data.tag_name ? data.tag_name : null;
} catch {
return null;
}
}
Comment thread
qinxuye marked this conversation as resolved.

async function fetchScript(ref) {
const url = `https://github.com/@raw/${REPO}/${ref}/${SCRIPT_PATH}`;
return fetch(url, {
headers: { "User-Agent": "get.xagent.co" },
cf: { cacheTtl: CACHE_TTL_SECONDS, cacheEverything: true },
signal: AbortSignal.timeout(10000), // a timeout here throws -> handler returns 502
});
}

const UNAVAILABLE = () =>
new Response("# Xagent installer temporarily unavailable\n", {
status: 502,
headers: { "content-type": "text/plain; charset=utf-8" },
});

export default {
async fetch(request) {
// Only the root path serves the installer; ignore /favicon.ico etc.
if (new URL(request.url).pathname !== "/") {
return new Response("Not Found\n", {
status: 404,
headers: { "content-type": "text/plain; charset=utf-8" },
});
}

try {
// Fail closed: only ever serve a resolved, immutable release tag.
const ref = await latestReleaseTag();
if (!ref) return UNAVAILABLE();

const res = await fetchScript(ref);
if (!res.ok) return UNAVAILABLE();

const body = await res.text();
return new Response(body, {
status: 200,
headers: {
// text/plain so `curl | sh` gets the raw script, never rendered HTML.
"content-type": "text/plain; charset=utf-8",
"cache-control": `public, max-age=${CACHE_TTL_SECONDS}`,
"x-xagent-install-ref": ref,
},
});
} catch {
// Any unexpected error → clean 502 text, never a Cloudflare HTML 500
// (which would break a piped `curl | sh`).
return UNAVAILABLE();
}
},
};
67 changes: 67 additions & 0 deletions scripts/get.xagent.co/worker.test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// Functional tests for the get.xagent.co Worker. Uses Node's built-in test
// runner (no dependencies) and stubs global fetch. Run: node --test
import assert from "node:assert/strict";
import { afterEach, test } from "node:test";

import worker from "./worker.js";

const realFetch = globalThis.fetch;
afterEach(() => {
globalThis.fetch = realFetch;
});

const get = (path = "/") => worker.fetch(new Request(`https://get.xagent.co${path}`));

test("non-root paths 404", async () => {
const res = await get("/favicon.ico");
assert.equal(res.status, 404);
});

test("fails closed (502) when the latest release can't be resolved", async () => {
Comment thread
qinxuye marked this conversation as resolved.
globalThis.fetch = async () => new Response("boom", { status: 500 });
const res = await get("/");
assert.equal(res.status, 502);
});

test("fails closed (502) when the release tag lacks the script", async () => {
globalThis.fetch = async (url) =>
String(url).includes("/releases/latest")
? new Response(JSON.stringify({ tag_name: "v9.9.9" }), { status: 200 })
: new Response("not found", { status: 404 });
const res = await get("/");
assert.equal(res.status, 502);
});

test("serves the script from the resolved release tag", async () => {
globalThis.fetch = async (url) =>
String(url).includes("/releases/latest")
? new Response(JSON.stringify({ tag_name: "v1.2.3" }), { status: 200 })
: new Response("#!/bin/sh\necho hi\n", { status: 200 });
const res = await get("/");
assert.equal(res.status, 200);
assert.equal(res.headers.get("content-type"), "text/plain; charset=utf-8");
assert.equal(res.headers.get("x-xagent-install-ref"), "v1.2.3");
assert.match(await res.text(), /echo hi/);
});

test("fails closed (502) when the release lookup rejects (e.g. timeout abort)", async () => {
// Exercises latestReleaseTag()'s try/catch (an AbortSignal.timeout abort or
// malformed JSON lands here) -> null -> 502.
globalThis.fetch = async () => {
throw new Error("boom");
};
const res = await get("/");
assert.equal(res.status, 502);
});

test("fails closed (502) when the script fetch rejects (e.g. timeout abort)", async () => {
// Tag resolves, then the raw fetch rejects -> the handler's outer try/catch.
globalThis.fetch = async (url) => {
if (String(url).includes("/releases/latest")) {
return new Response(JSON.stringify({ tag_name: "v1.2.3" }), { status: 200 });
}
throw new Error("boom");
};
const res = await get("/");
assert.equal(res.status, 502);
});
9 changes: 9 additions & 0 deletions scripts/get.xagent.co/wrangler.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name = "xagent-get"
main = "worker.js"
compatibility_date = "2026-07-01"

# Serve the installer at https://get.xagent.co (the zone must be on this
# Cloudflare account; adjust if the domain moves).
routes = [
{ pattern = "get.xagent.co", custom_domain = true },
]
79 changes: 79 additions & 0 deletions scripts/install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
#!/bin/sh
# Xagent installer — https://get.xagent.co
#
# curl -fsSL https://get.xagent.co | sh
#
# Installs the `xagent-ai` package (backend + bundled web UI) as an isolated uv
# tool, so nothing touches your system Python and PEP 668 never bites. On
# success the `xagent` command is available; start it and open the browser.
#
# Options (environment variables):
# XAGENT_VERSION pin a specific version, e.g. XAGENT_VERSION=0.6.0
#
# Prefer not to pipe curl into sh? The equivalent manual install is:
# uv tool install xagent-ai # or, in a venv: pip install xagent-ai
set -eu
Comment thread
qinxuye marked this conversation as resolved.

# The user's PATH before this script mutates it (below, when bootstrapping uv).
# Used at the end to warn correctly about whether the parent shell will find the
# installed command.
ORIG_PATH="$PATH"

APP="xagent-ai"
CMD="xagent"

info() { printf '\033[1;34m==>\033[0m %s\n' "$1"; }
warn() { printf '\033[1;33mwarning:\033[0m %s\n' "$1" >&2; }
err() {
printf '\033[1;31merror:\033[0m %s\n' "$1" >&2
exit 1
}

# uv supports Linux and macOS. Windows users should use pip in a venv.
os="$(uname -s)"
case "$os" in
Linux | Darwin) ;;
*) err "Unsupported OS '$os'. On Windows, install with: pip install $APP (in a virtualenv)." ;;
esac

# Ensure uv is available (isolates the install; avoids system-Python/PEP 668).
if ! command -v uv >/dev/null 2>&1; then
info "Installing uv (Python tool manager)..."
curl -LsSf https://astral.sh/uv/install.sh | sh
# uv installs into ~/.local/bin (or ~/.cargo/bin on older installers); make it
# visible to the rest of this script without requiring a new shell.
for d in "$HOME/.local/bin" "$HOME/.cargo/bin"; do
Comment thread
qinxuye marked this conversation as resolved.
[ -d "$d" ] && PATH="$d:$PATH"
done
export PATH
fi
command -v uv >/dev/null 2>&1 || err "uv not found on PATH after install; open a new shell and re-run."

spec="$APP"
if [ -n "${XAGENT_VERSION:-}" ]; then
# Strip a leading 'v' (e.g. v0.6.0 -> 0.6.0) so a git-tag-style value works.
version="${XAGENT_VERSION#v}"
Comment thread
qinxuye marked this conversation as resolved.
[ -n "$version" ] || err "XAGENT_VERSION='$XAGENT_VERSION' is not a valid version."
spec="$APP==$version"
fi
Comment thread
qinxuye marked this conversation as resolved.

info "Installing $spec ..."
uv tool install --upgrade "$spec"

printf '\n'
info "Installed. Next steps:"
printf '\n'
printf ' Start Xagent: %s\n' "$CMD"
printf ' Open: http://127.0.0.1:8000\n'
printf ' Configure an LLM key (e.g. OPENAI_API_KEY) via a .env file or env var.\n'
printf '\n'

if ! PATH="$ORIG_PATH" command -v "$CMD" >/dev/null 2>&1; then
warn "'$CMD' is not on your PATH in this shell yet."
if PATH="$ORIG_PATH" command -v uv >/dev/null 2>&1; then
warn "Run 'uv tool update-shell' and open a new terminal, then run '$CMD'."
else
# uv was just installed by this script and isn't on the parent shell's PATH.
warn "Open a new terminal, or run: export PATH=\"\$HOME/.local/bin:\$PATH\""
fi
fi
Comment thread
qinxuye marked this conversation as resolved.
Loading