Aurora

Installation ​

Aurora is distributed in two ways. Pick whichever fits your situation:

  • Option A — Direct download. No auth, no .npmrc. Install via a versioned URL. Best for folks without GitHub access, or anyone who wants the simplest possible install. Trade-off: exact-version pinning — to upgrade, you change the URL.
  • Option B — GitHub Packages. Standard pnpm add @scaler-tech/aurora flow. Requires a GitHub Personal Access Token. Supports semver ranges (^0.1.0).

Both paths come from the same release tag and produce identical packages.

Quick install via an AI assistant ​

Paste the prompt below into Claude Code, Cursor, or any AI coding tool — it'll ask which install path you want and walk through the rest.

You're installing @scaler-tech/aurora — Scaler's Vue 3 design system.

Two install paths exist. ASK ME which one I want before doing anything:

  Option A — Direct download (no auth required)
    NOTE: this path is currently TBD — Aurora's S3 release host isn't
    deployed yet. If I pick A, recommend B until it ships.
  Option B — GitHub Packages (requires GitHub PAT with read:packages)

If A (once live), the install is one command. Ask me which version to
pin — if I don't know, fetch https://aurora.staging.sclr.run/ and use
whatever the docs site reports as the latest published version. Then run:
  pnpm add https://aurora.staging.sclr.run/releases/<VERSION>/scaler-tech-aurora-<VERSION>.tgz vue

If B, walk through:
  1. Confirm I have a GitHub PAT with `read:packages` scope. If not,
     point me at https://github.com/settings/tokens/new and tell me to
     create a classic token with that single scope.
  2. Create or update `.npmrc` in the project root with these two lines:
       @scaler-tech:registry=https://npm.pkg.github.com
       //npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
     Tell me to export `GITHUB_TOKEN=ghp_…` in my shell. Do NOT hardcode
     the token in .npmrc. For CI, recommend using GITHUB_TOKEN as a
     repository secret.
  3. Install: pnpm add @scaler-tech/aurora vue

Both paths then need the Tailwind v3 toolchain — Aurora is NOT compatible
with Tailwind v4:
  pnpm add -D autoprefixer postcss tailwindcss@^3.4

Ask me which optional components I plan to use, then install only the
relevant peers:
  - DatePicker  → @internationalized/date
  - Table       → @tanstack/vue-table
  - Tooltip / Menu / any Popper-based component → @vueuse/motion
  - Markdown    → marked dompurify
  - Combobox    → fuse.js
  - PdfViewer   → pdfobject

Verify with `pnpm list @scaler-tech/aurora` — should show the installed
version. If pnpm returns 401 Unauthorized on Option B, the token isn't
exported in the current shell or it's missing `read:packages`.

Stop. Tailwind config (aurora preset + content paths + plugins) is a
separate page in the docs — don't attempt it unless I ask.

If any step fails, pause and show the actual error output. Don't guess.

Or follow the manual steps below.

Option A: Direct download ​

Coming soon — TBD

Aurora's S3 release host isn't deployed yet. Until it ships, use Option B. The instructions below describe the final flow.

A single command pulls the tarball straight from Aurora's release host. No registry, no token.

bash
pnpm add https://aurora.staging.sclr.run/releases/0.1.4/scaler-tech-aurora-0.1.4.tgz vue

The URL is version-pinned. To upgrade, change the version segment in the URL — semver ranges aren't supported.

Latest version

The latest published version is listed at https://aurora.staging.sclr.run/. Replace 0.1.4 in the URL above with whichever version you want to pin.

Then install the Tailwind toolchain below.

Option B: GitHub Packages ​

1. Create a Personal Access Token ​

Go to https://github.com/settings/tokens/new and create a classic token:

  • Scope: only read:packages
  • Expiration: whatever your team policy allows

Copy the ghp_… token. Treat it like a password.

2. Configure your registry ​

Create or edit .npmrc in your project root:

ini
@scaler-tech:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

Then export the token in your shell. Don't hardcode it in .npmrc:

bash
export GITHUB_TOKEN=ghp_yourTokenHere

For CI, set GITHUB_TOKEN as a secret. For local dev, add the export to your shell profile or use a tool like direnv.

3. Install aurora ​

bash
pnpm add @scaler-tech/aurora vue

pnpm's auto-install-peers (on by default in v8+) pulls aurora's required peer deps into the dependency tree — you don't need to list them all. You do still need vue as a direct dep, because your own code imports from 'vue' and pnpm only hoists what you declare directly.

The same rule applies to anything else you import explicitly in your own source (e.g., @vueuse/core composables, vee-validate helpers): if your code references it, install it directly.

Tailwind toolchain ​

Both install paths need Tailwind v3 in dev deps — Aurora is not yet compatible with v4:

bash
pnpm add -D autoprefixer postcss tailwindcss@^3.4

Tailwind v3 only

The @tailwindcss/forms, @tailwindcss/typography, and @tailwindcss/container-queries plugins are declared as required peers — pnpm pulls them in automatically.

Optional peers ​

Some components depend on libraries most apps won't use. They're marked optional so missing-peer warnings don't fire unless you actually need them. Install only what you use:

ComponentInstall
DatePickerpnpm add @internationalized/date
Tablepnpm add @tanstack/vue-table
Tooltip/Menu/Popper*pnpm add @vueuse/motion
Markdownpnpm add marked dompurify
Comboboxpnpm add fuse.js
PdfViewerpnpm add pdfobject

*Popper-based components animate via the v-motion directive. After installing @vueuse/motion, register the plugin in main.ts — see Tailwind setup for the snippet.

Verify ​

bash
pnpm list @scaler-tech/aurora

You should see the version you installed. If you used Option B and pnpm asks for credentials or fails with 401 Unauthorized, your GITHUB_TOKEN isn't exported in this shell or the token is missing read:packages.

Next ​

→ Configure Tailwind so aurora's tokens, components, and prose styles render correctly.