Getting Started

How to install SmartAC Ambient UI packages.

To install the UI package, you must authenticate to the GitHub package registry. Additionally, you need to be a member of the SmartAC GitHub organization, as packages from internal projects cannot be accessed anonymously.

To authenticate, you must create a personal access token (classic) with the scope set to read:packages. Follow these steps to create your token:

On the right sidebar, select your avatar.
Select Settings.
On the left sidebar, select Developer settings.
Select Personal access tokens.
Select Tokens (classic).
Optionally, in Token description, enter a description for the token.
In Expiration date, enter an expiration date for the token.
Select read:packages in the Scopes section.
Select Generate token.

Once created, copy the token immediately as it will not be displayed again. For additional details, refer to the GitHub documentation on personal access tokens.

Installing the UI Package

In your project root directory, create or edit a .npmrc file and add the following:

//npm.pkg.github.com/:_authToken=<token>
@smartacteam:registry=https://npm.pkg.github.com/

Note: Replace <token> with the personal access token you created earlier.

Install the design system tokens

To install the design system tokens, run the following command:


bun add @smartacteam/ambient-tokens

Next, install the ambient (web) package by running the following command:


bun add @smartacteam/ambient-web

Framework guides

Next.js