agentleFS
rahmanef63rahmanef63/si-coder-agent/skills/sc-vercel/SKILL.md

sc-vercel

Skill13 starsChanged 2 months agoMITView on GitHub

Vercel deploy as online frontend host. Create project bound to a GitHub repo, set CONVEX_DEPLOY_KEY, set build command to couple Convex Cloud deploy + Next.js build (injects NEXT_PUBLIC_CONVEX_URL), add a custom domain or subdomain, configure Hostinger DNS (CNAME for subdomain / A for apex) from Vercel's required config, trigger + poll deploy. Pairs with /sc-convex-cloud for the Convex Cloud backend.

The file

We split this skill into the rules it gives an agent

5 rules. About 0 are common, 3 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    When VERCEL_TOKEN is stored in a direct SI-Coder named connection, run this skill's credential-dependent helper through sc run -- ...:

    line 30
  2. Distinctive:

    Add the custom domain/subdomain (tolerate 409 already-assigned).

    line 53
  3. Distinctive:

    Read the exact required DNS from Vercel's domain config.

    line 54
  4. Very specific:

    Mandate: do NOT also hand-set NEXT_PUBLIC_CONVEX_URL in Vercel for the same coupled env — the repository command or --cmd injection is the …

    line 80
  5. Distinctive:

    Read live from Vercel's domain config.

    line 84

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

/sc-vercel — Vercel (online frontend)

Status: implemented (online path).

flowchart TD
    A["/sc-vercel"] --> B["find/create Vercel project<br/>(bound to GitHub repo)"]
    B --> C["set CONVEX_DEPLOY_KEY (encrypted)"]
    C --> D["set coupled build cmd<br/>npx convex deploy --cmd 'npm run build'"]
    D --> E["add custom domain / subdomain"]
    E --> F["read required DNS from Vercel<br/>(array-normalized + IPv4 guard)"]
    F --> G["Hostinger DNS<br/>CNAME (sub) / A (apex)"]
    G --> H["trigger deploy + poll readyState<br/>(15-min cap, blip-tolerant)"]
    H --> I["live URL ✅<br/>NEXT_PUBLIC_CONVEX_URL injected at build"]

Connection-safe local execution

When VERCEL_TOKEN is stored in a direct SI-Coder named connection, run this skill's credential-dependent helper through sc run -- ...:

sc run -- node skills/sc-vercel/scripts/deploy.js --help

The plain node ... examples below are script-interface examples for callers that already supply the required environment. A Composio/native-MCP Vercel connection must execute through that external backend.

When to use

  • You want Vercel's edge network for the Next.js frontend, with the Convex backend on Convex Cloud (managed).
  • You don't want to deal with a Dockerfile / Compose for the frontend.
  • The online counterpart to the self-hosted Dokploy path. Pair with /sc-convex-cloud for the backend.

Scope (implemented)

scripts/deploy.js is a single 12-step orchestrator:

  1. Build a team-aware Vercel client from VERCEL_TOKEN (+ optional VERCEL_TEAM_ID).
  2. Resolve the GitHub repo: --git-owner/--git-repo, else read origin from the local git remote.
  3. findOrCreateProject({ name, gitRepo, framework:'nextjs' }) — bind the repo on create.
  4. Set env vars: CONVEX_DEPLOY_KEY (type:'encrypted', Production only — it's a prod key). Do not set NEXT_PUBLIC_CONVEX_URL (injected by the build).
  5. Resolve the build command without overriding the repo: explicit --build-command → repo vercel.json → Bun/npm-aware Convex fallback. This lets repositories can keep their own gated bun run build:auto contract.
  6. Add the custom domain/subdomain (tolerate 409 already-assigned).
  7. Read the exact required DNS from Vercel's domain config.
  8. Configure Hostinger DNS (TXT ownership challenge first if unverified, then the A/CNAME pointing record), or print the records to add manually if no HOSTINGER_API_TOKEN.
  9. Trigger the first deploy (git-linked projects auto-deploy on push; force the initial one).
  10. Poll getDeployment every 4s until readyState ∈ {READY, ERROR, CANCELED}.
  11. Soft-poll DNS propagation (misconfigured === false) up to ~60s — never hard-fail (cert/record can lag).
  12. Print summary: project id, deployment URL, custom domain, DNS record applied, Convex Cloud URL.

Env vars

VarRequiredPurpose
VERCEL_TOKENyesPersonal access token, https://vercel.com/account/tokens
VERCEL_TEAM_IDoptionalFor team-scoped projects; appended as ?teamId= to every API call
CONVEX_DEPLOY_KEYyesConvex Cloud production deploy key. Set on Vercel as encrypted, Production-only. NEVER logged
HOSTINGER_API_TOKENoptionalEnables automatic DNS record writes. Without it, the records are printed for manual entry

Build command

Resolution order is authoritative and package-manager-aware:

  1. --build-command <cmd> when an operator explicitly supplies one.
  2. vercel.json → buildCommand for the normal coupled path. A repository that already owns its gate/deploy orchestration must not be replaced by a generic npm command.
  3. Generated fallback: Bun repos use bunx convex deploy --cmd 'bun run build'; npm repos use npx convex deploy --cmd 'npm run build'. Both include --cmd-url-env-var-name NEXT_PUBLIC_CONVEX_URL.

--decoupled deliberately bypasses a potentially coupled vercel.json command and runs only the package-manager-native frontend build.

Mandate: do NOT also hand-set NEXT_PUBLIC_CONVEX_URL in Vercel for the same coupled env — the repository command or --cmd injection is the single source of truth. The NEXT_PUBLIC_ prefix is required because Next.js does not expose the default CONVEX_URL to the browser.

DNS logic

Read live from Vercel's domain config; do not hardcode:

  • Subdomain (e.g. app.example.com) → CNAME to recommendedCNAME[0].value (fallback cname.vercel-dns.com).
  • Apex (e.g. example.com) → A to the first IP of recommendedIPv4[rank=1].value (an array; pick value[0], fallback 76.76.21.21).
  • TXT ownership challenge from verification[] when the domain reports verified:false — added first, then verifyDomain is called.

CONVEX_DEPLOY_KEY is a secret: passed via env to the Vercel encrypted env, and never echoed by any script. Only NEXT_PUBLIC_CONVEX_URL (public) is printed.

Scripts

node skills/sc-vercel/scripts/deploy.js \
  --project myapp --app myapp --domain app.example.com \
  --git-owner <your-gh-user> --git-repo myapp --prod
FlagMeaning
--project <name>Vercel project name (defaults to --app if omitted)
--app <name>Logical app name (defaults to --project)
--domain <host>Full host to attach — apex example.com OR subdomain app.example.com
--git-owner <o> / --git-repo <r>GitHub owner/name; if absent, read from git remote get-url origin
--ref <branch> / --branch <branch>Git ref/branch to deploy; if absent, derived from git rev-parse --abbrev-ref HEAD, else main (use this for master-default repos)
--prodDeploy the production target / alias
--decoupledOpt-out of coupled build: set NEXT_PUBLIC_CONVEX_URL from env and run only the frontend build
--build-command <cmd>Explicit project build command; otherwise repo vercel.json then Bun/npm fallback wins
--cwd <path>Working dir for git-remote and build-contract resolution (default: process cwd)

File layout

sc-vercel/
├── SKILL.md
└── scripts/
    ├── _shared.js   # getClient (VERCEL_TOKEN/VERCEL_TEAM_ID) + parseArgs
    └── deploy.js    # 12-step orchestrator (project + env + build + domain + DNS + deploy)

Note: the old "suggested file layout" with separate project.js / env.js / domain.js is superseded — project/env/domain/deploy are consolidated into deploy.js on top of the lib/vercel.js client.

Implementation notes

  • API base: https://api.vercel.com; auth Authorization: Bearer <VERCEL_TOKEN>; team projects append ?teamId=<VERCEL_TEAM_ID> to every URL.
  • A git-linked project only auto-deploys if the Vercel GitHub App is installed on the repo/org. deploy.js cannot install it headlessly; a triggerDeploy 403 surfaces a clear hint to install the App.
  • Cross-skill: /sc-all --target vercel skips the Dokploy app + self-hosted Convex; it uses /sc-convex-cloud + /sc-vercel instead.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.