Site deploy

This pack gives an agent one tool, siteDeploy, that plans a deployment to Vercel, Cloudflare Pages, DigitalOcean, Netlify, Heroku, AWS, Linode, Railway or Fly.io, with optional domain registration and DNS setup, and carries it out by calling other tools through a tool executor the host attaches.

Installation

npm install @framers/agentos-ext-tool-site-deploy

Peer dependency: @framers/agentos with range >=0.10.40.

Usage

import { AgentOS } from '@framers/agentos';

const agentos = await AgentOS.create({
  extensionManifest: {
    packs: [{ package: '@framers/agentos-ext-tool-site-deploy' }],
  },
});

Tools

| Tool | What it does | | --- | --- | | siteDeploy | Deploys a site from a Git repository or local directory with optional custom domain registration and DNS configuration. |

siteDeploy parameters

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | source | string | Yes | Git repository URL or local directory path | | cloudProvider | string, enum: vercel, cloudflare, digitalocean, netlify, heroku, aws, linode, railway, flyio | No | Cloud provider to deploy to (default: auto-detect best fit) | | domain | string | No | Custom domain to configure (optional). If not registered, will attempt to register via domainRegistrar. | | domainRegistrar | string, enum: porkbun, namecheap, godaddy, cloudflare | No | Domain registrar to use for domain purchase (required if domain is not already registered) | | framework | string, enum: nextjs, react, vue, svelte, astro, static, node, python, auto | No | Framework/runtime (default: auto-detect) | | envVars | object<string, string> | No | Environment variables to set on the deployment | | buildCommand | string | No | Build command override | | outputDirectory | string | No | Output directory override | | dryRun | boolean | No | Preview the deployment plan without executing (default: false) |

Notes

The factory does not attach a tool executor. The host attaches one through SiteDeployTool.setToolExecutor on the tool payload and supplies the provider and registrar tools. Deployment fails with a missing executor error if no callback is attached. dryRun returns a plan without calling delegated tools.

Framework detection examines the source URL or path string. It falls back to static when no pattern matches. Automatic provider selection uses Vercel for Next.js, React, Vue and Svelte, Cloudflare for Astro and static sites, and Railway for Node and Python.

For the deployment, siteDeploy calls one tool per provider with the arguments source, framework and, when given, envVars, buildCommand and outputDirectory: vercelDeploy, cfDeployPages, doCreateApp, netlifyDeploy, herokuDeploy, awsDeploy, linodeDeploy, railwayDeploy, flyioDeploy. The curated cloud packs register the first three under those names, and those three take other arguments (gitUrl, and name for doCreateApp). The other six names are not tools any curated pack registers. The host's executor has to map each call to a real tool and its arguments.

For the domain, it calls the registrar's search tool with domain, its register tool with domain and years: 1 when the domain is available, and its DNS tool with domain, action: 'add', type, name and content for an apex CNAME. Porkbun's tools accept those arguments. Namecheap's register tool needs domainName and registrant, GoDaddy's needs contactRegistrant, and Namecheap's DNS tool needs a records array, so those calls fail unless the executor adapts them. The Cloudflare registrar path skips registration. Without a registrar, domain setup returns manual DNS instructions.

A deployment failure stops domain setup. A returned domain registration or DNS failure appears in domainStatus and the step results while a successful deployment keeps the overall result successful.

License

Apache-2.0