@astryx-vue/cli

English | 简体中文

astryx-vue

Unofficial Vue 3 port of Astryx — components, themes, and an agent-friendly CLI.

Not affiliated with, endorsed by, or supported by Meta. The original Astryx is at https://github.com/facebook/astryx.

Install

pnpm add @astryx-vue/core @astryx-vue/themes

The only peer dependency is vue ^3.5.0. npm and yarn use the same package names.

Quick start

Import one theme at the app entry. Neutral also applies on :root, and it brings Figtree and JetBrains Mono.

import '@astryx-vue/themes/neutral.css'

Import each component from its own subpath. That entry loads the matching structural styles. StyleX and UnoCSS are not required.

<script setup lang="ts">
import { Button } from '@astryx-vue/core/Button'
</script>

<template>
  <Button label="Get started" />
</template>

Packages

core and themes publish together. @astryx-vue/cli is already on npm and versions on its own.

CLI

Install the CLI as a dev dependency. The package declares a bin, so the command lands on node_modules/.bin:

pnpm add -D @astryx-vue/cli
pnpm exec astryx-vue component Button
npx astryx-vue search dialog

Without installing it, run npx @astryx-vue/cli …; the scope is required, because the bare astryx-vue name on npm is not this package.

pnpm exec astryx-vue build "login page with SSO"
pnpm exec astryx-vue template login-card ./src/pages
pnpm exec astryx-vue manifest --json
pnpm exec astryx-vue init --features agents

init --features agents refreshes only the managed block in AGENTS.md. Text outside the markers stays. The guide is CLI.

Resources

• Docs: https://astryx-vue.pages.dev (English: https://astryx-vue.pages.dev/en/)
• Playground: https://astryx-vue.pages.dev/playground/ (English: https://astryx-vue.pages.dev/en/playground/)
• Components: https://astryx-vue.pages.dev/en/components/
• Themes: https://astryx-vue.pages.dev/en/themes/

Development

Node.js 22.18+ and pnpm 11.21+.

pnpm install
pnpm dev      # docs site
pnpm check    # lint, typecheck, test, and build

Release steps are in RELEASING.md.

License

MIT. Astryx is copyright Meta Platforms, Inc. This repository is an unofficial port of that design and is not affiliated with or endorsed by Meta.