# Installation

> What to install from npm, for a design system that builds its components with the CLI and for an app that compiles them with the bundler plugin.

Unframework fits into a project in one of two ways. A design system writes its components once and builds them for every framework with the `unframework` command, then publishes them as one package. An app imports `.uf.tsx` components, its own or a design system's, and the bundler plugin compiles them to the app's framework as part of its build. Most teams use both: the design system builds, and its apps install the result.

## What you install

| Package                     | What it gives you                                                                                                                 | Who needs it                         |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| `@uxfront/unframework`      | The authoring API that a `.uf.tsx` file imports, its JSX types, `defineConfig` and the [`unframework` command](/docs/tooling/cli) | every project                        |
| `@unframework.dev/unplugin` | The [bundler plugin](/docs/tooling/bundler-plugin), and the Astro integration                                                     | an app that compiles `.uf.tsx` files |
| `typescript`                | `tsc`, to type-check `.uf.tsx` files through `tsconfig.uf.json`                                                                   | any project that type-checks         |

[Packaging](/docs/tooling/packaging#install-the-packagers) lists what each framework's packager needs, for a design system that publishes a package.

We build and test with Node 24, TypeScript 7 and Vite 8.

## Install the packages

The packages are on npm. Every project installs `@uxfront/unframework`:

```bash
npm install @uxfront/unframework
```

An app that compiles `.uf.tsx` files adds the bundler plugin, and a project that type-checks adds TypeScript:

```bash
npm install @unframework.dev/unplugin typescript
```

Keep in mind that the unscoped `unframework` on npm is another project's package, so don't install it.

## Start a project

With `@uxfront/unframework` installed, `unframework init` writes a config, an example component with its stylesheet, `tsconfig.uf.json` and `AGENTS.md`, and `unframework check` passes on them. In a new directory, `create-unframework <dir>` writes a `package.json` that depends on `@uxfront/unframework`. Once you've installed its dependencies, run `unframework init` there. [The CLI](/docs/tooling/cli#init) lists what each file holds.

From there:

- **To build a design system,** set your targets in [`unframework.config.ts`](/docs/tooling/configuration), then run `unframework build`, or `unframework build --package` to [package](/docs/tooling/packaging) it.
- **To use components in an app,** add the [bundler plugin](/docs/tooling/bundler-plugin) to your Vite config, or the Astro integration, and import a `.uf.tsx` file.
- **To write components,** start with [Props](/docs/components/props).
