Augeo AI Docs
Augeo Design SystemGetting Started

Install Tokens

How Augeo default tokens ship through the public stylesheet and ThemeProvider.

Augeo tokens ship from @kigo-digital/design-system — the same package that ships components. Public consumers import the compiled stylesheet and use ThemeProvider; raw token JSON/CSS files are internal build artifacts.

Prerequisites — GitHub Packages authentication

The package is published to GitHub Packages under the @kigo-digital scope, with access: restricted. Consumers need a GitHub personal-access token (classic, with read:packages) to install.

Add an .npmrc at the root of your consuming project:

@kigo-digital:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_PACKAGES_TOKEN}

Set GITHUB_PACKAGES_TOKEN in your shell or CI environment. Do not commit the token — only the variable reference.

Install

npm install @kigo-digital/design-system

Public CSS

The public CSS bundle declares Augeo defaults on :root and includes component utility rules. Import once at your app entry:

@import '@kigo-digital/design-system/styles.css';

Then wrap your app with the default theme:

import { ThemeProvider, augeoTheme } from '@kigo-digital/design-system';

export default function App({ children }) {
  return <ThemeProvider theme={augeoTheme}>{children}</ThemeProvider>;
}

Inside the provider you get variables such as --augds-background-brand, --augds-foreground-primary, --augds-surface-page, --augds-border-default, --augds-status-error-fg, and --augds-interaction-focus-ring.

Internal Token Artifacts

Style Dictionary still emits internal artifacts under dist/tokens/ during local builds. They are consumed by the package build and docs tooling, but they are not public package exports.

Re-theming for a partner

Supply a brand ramp, not individual color slots. Derive one with node scripts/generate-brand-ramp.mjs "#c20023" cnh, then pass it to ThemeProvider:

import { ThemeProvider, baseTheme, type DesignSystemTheme } from '@kigo-digital/design-system';

const partnerTheme: DesignSystemTheme = {
  ...baseTheme,
  brandRamp: {
    50: '#fff2f1',
    100: '#ffe5e3',
    200: '#fecbc6',
    300: '#fea7a1',
    400: '#fc7672',
    500: '#fd303f',
    600: '#da172e',
    700: '#c20023',
    800: '#96081b',
    900: '#7e0916',
    950: '#4f0209',
  },
  // This brand's color lands on step 700, so `primary` moves off its default,
  // which assumes 950. The tints and the shade are the same steps for every brand.
  brandRoles: { primary: 700 },
};

export function Root({ children }) {
  return <ThemeProvider theme={partnerTheme}>{children}</ThemeProvider>;
}

Inside that scope, every Augeo component picks up the new colors with no code change.

Setting colors.partner.* instead does not work, and gives no error — the variables still resolve, just to Augeo's defaults. See Partner theming for the full mechanism.

Versioning

Tokens follow SemVer with the package:

  • Major — renamed semantic roles, removed primitives, breaking shape changes.
  • Minor — additive primitives or aliases, new tokens.
  • Patch — value tweaks that preserve names and contracts.

Pin to a specific version (@kigo-digital/design-system@0.5.1) and bump deliberately. See Changelog for what's shipped.