Skip to content

Quickstart

import { Steps, Tabs, TabItem, Aside } from ‘@astrojs/starlight/components’;

You’ll need:

  1. Install the CLI globally.

    ```sh npm install -g @vantageconnections/cli ``` ```sh pnpm add -g @vantageconnections/cli ``` ```sh npx -y @vantageconnections/cli login ```
  2. Mint a personal access token.

    Open https://vantageconnections.dev/admin/settings/api-keys, click New key, give it a name (e.g. “my laptop”), and copy the value. Tokens start with vc_pat_ and are shown once — store it somewhere safe.

  3. Log in.

    Terminal window
    vantage login

    Paste the token when prompted. Credentials are saved to ~/.vantage/credentials.json with mode 0600.

  4. Verify the install.

    Terminal window
    vantage selftest

    You should see four green checks: credentials loaded → token format → /v1/me returns your identity → /v1/websites returns the sites you can reach. If anything fails, the output tells you exactly how to fix it.

  5. Create your first website.

    Terminal window
    vantage websites create --name "Joe's Plumbing" --slug joes-plumbing

    The response includes a websiteId (e.g. wb_01J7...). Behind the scenes the orchestrator is now:

    • Creating github.com/Vantage-Connections-Org/client-joes-plumbing from the website template
    • Adding the GitHub bot as a collaborator
    • Creating a Vercel project linked to that repo
    • Seeding env vars and triggering the first deployment
    • Marking the site active when the deploy is live

    This takes ~60-90 seconds end-to-end.

  6. Watch it provision.

    Terminal window
    vantage websites get <websiteId>

    status walks through provisioningactive. Re-run every 20-30 seconds.

    Or open the portal at https://vantageconnections.dev/admin/websites/<websiteId> for the live Blueprint view — you’ll watch each node turn green as it provisions.

  7. Visit your new site.

    Once status: "active", the Vercel preview URL is in the response under services[].externalUrl (the row with serviceType: "vercel"). Open it in a browser — that’s the default website-template content, ready for you to edit.

You have a live, hosted Next.js site under your management. Common next steps:

Token format looks right but /v1/me returns 401. Token was probably revoked in the portal, or you copied it truncated. Mint a fresh one and re-run vantage login.

/v1/websites returns 403. You’re logged in as a client role, not admin — clients only see their own site, so the list endpoint is gated. Use vantage websites get <yourSiteId> instead.

vantage websites create returns slug already exists. Slugs are globally unique. Pick another or vantage websites list to find the existing one.

Anything else? Run vantage selftest first — it diagnoses the four most common failure modes with explicit fix instructions.