@adsights-ai / ads-framework

Setup guide

Pick the install path that fits your environment. Both deliver the same engine, skills, and templates — they differ only in how you receive updates.

Path A · 3 min

Download as zip

Self-contained. No GitHub account, no .npmrc. Updates by re-download.

Path B · 5 min

Private npm registry

GitHub Packages flow. Auto-updates via pnpm up. Requires a read:packages PAT.

Path A

Download as zip

For agencies, corporate environments, evaluators, and anyone who’d rather not configure a private npm registry. The zip is self-contained — extract, install, render.

  1. 1

    Download the zip

    Sign in at /account, open the license detail page, click Download as zip. The file is adsights-ads-framework-v0.1.0.zip (~130 KB).

  2. 2

    Extract + install

    bash
    unzip adsights-ads-framework-v0.1.0.zip
cd adsights-ads-framework-v0.1.0/starter-project
pnpm install

    pnpm install resolves the engine and CLI against the tarballs in ../packages/ via file: protocol — zero registry traffic, works offline.

  3. 3

    Render your first ad

    bash
    pnpm ads:studio                                       # opens Remotion Studio at :3030
pnpm ads:render product-showcase --format=social-square
  4. 4

    Use the skills anywhere (optional)

    The zip’s top-level .claude/ directory is portable Markdown. Drop it into any Claude-capable project and the skills (/storyboard, /ads-copy, /create-ad, /voiceover, etc.) become available immediately:

    bash
    cp -r .claude /path/to/your-other-project/

Updating later

When a new framework version ships, visit /account and re-download. Your starter-project/ customizations stay intact — replace only the packages/ folder and re-run pnpm install.

Path B

Private npm registry (GitHub Packages)

For dev teams who want pnpm up upgrades and don’t mind a one-time GitHub Packages setup. The five steps below are mechanical; total time is ~5 minutes.

  1. 1

    Accept your GitHub team invite

    After payment we send an invite to the GitHub username you provided at checkout. It arrives in your GitHub notifications inbox + via email from GitHub.

    If you missed the username field at checkout, set it on your /account page and the invite will resend automatically.

  2. 2

    Create a read:packages PAT

    GitHub → Settings → Developer settings → Personal access tokens (classic) → Generate new token. Scopes: read:packages. Set expiration to 1 year (lifetime tokens are not recommended).

  3. 3

    Configure .npmrc

    In your project root, create or edit .npmrc:

    .npmrc
    @adsights-ai:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_PAT_HERE

    Don’t commit your token. Most teams add the PAT via .npmrc.local + a CI secret, or set NODE_AUTH_TOKEN in their shell.

  4. 4

    Scaffold a fresh project

    bash
    npx create-adsights-ads@latest my-ads
cd my-ads
pnpm install

    The scaffolder asks for your brand name + primary + accent colors, then writes ads.config.ts + compositions/ + .claude/skills/.

  5. 5

    Render your first ad

    bash
    pnpm ads:studio                                       # opens Remotion Studio at :3030
pnpm ads:render product-showcase --format=social-square
ls out/ads/product-showcase__social-square.mp4

    Or run /ads-quickstart "<your product>" in Claude Code from the project root — five-minute wizard, brief in, MP4 out.

Need help?

Most setup issues self-resolve at your /account page — license status, GitHub invite state, and the zip download all live there.

For anything else, reply to your purchase receipt email. Setup-time questions get a response within one business day.