Augeo AI Docs
Augeo Design SystemAgent Consumers

Using with AI agents

How AI agents should consume @kigo-digital/design-system.

Using with AI agents

This page mirrors the AGENTS.md file that ships at the package root.

Restricted public surface

The package exports ., ./styles.css, ./tokens-v2.css, and ./theme-augeo.css. Token JSON, partner, registry, and Tailwind paths are internal.

Install prerequisites

This package is published to GitHub Packages. Consumer projects need:

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

Provide GITHUB_PACKAGES_TOKEN outside source control.

Generate Augeo UI

import "@kigo-digital/design-system/styles.css";
import { Button, ThemeProvider, augeoTheme } from "@kigo-digital/design-system";

export function App() {
  return (
    <ThemeProvider theme={augeoTheme}>
      <Button>Redeem offer</Button>
    </ThemeProvider>
  );
}

Multi-brand UI

Construct a complete DesignSystemTheme and pass it to ThemeProvider.

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

const partnerTheme: DesignSystemTheme = {
  ...baseTheme,
  colors: {
    ...baseTheme.colors,
    partner: {
      ...baseTheme.colors.partner,
      primary: "#367c2b",
      "primary-emphasis": "#1f5f1a",
      "primary-tint-10": "#e6f0e4",
      "primary-tint-25": "#c3d9bf",
      "on-primary": "#ffffff",
    },
  },
};

export function PartnerRoot({ children }: { children: React.ReactNode }) {
  return <ThemeProvider theme={partnerTheme}>{children}</ThemeProvider>;
}

Hard rules for agents

RuleWhy
Never hard-code hex in component stylesUse --augds-* tokens or a DesignSystemTheme value
Never invent registry entriesThe component contract is authored in the repo
Never strip focus ringsThey are the accessible focus indicator
Never import token, partner, registry, or Tailwind package pathsThey are not public exports
Never tell consumers to paste package-owned Tailwind mappingsstyles.css is the public styling contract
Never cross product lines at runtimeAugeo and Kigo Pro share utilities, not components
Never auto-select a component whose export carries @deprecatedIt is on its way out