# @astel/cli

> CLI tools for Astel UI

Latest version **0.0.8** (published 2022-05-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @astel/cli
pnpm add @astel/cli
yarn add @astel/cli
bun add @astel/cli
```

Provides the command `astel`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2022-05-02 |
| First published | 2022-04-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 21 |
| Unpacked size | 92.5 KB |
| Known vulnerabilities | 0 (+16 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sumit Kolhe |
| Maintainers | sumitkolhe |

## Links

- npm: https://www.npmjs.com/package/@astel/cli
- Repository: https://github.com/astel-org/cli
- Issues: https://github.com/astel-org/cli/issues
- npm.io page: https://npm.io/package/@astel/cli

## Dependencies (21)

- [vue](https://npm.io/package/vue.md) ^3.2.33
- [defu](https://npm.io/package/defu.md) ^6.0.0
- [less](https://npm.io/package/less.md) ^4.1.2
- [vite](https://npm.io/package/vite.md) ^2.9.5
- [rollup](https://npm.io/package/rollup.md) ^2.70.2
- [consola](https://npm.io/package/consola.md) ^2.15.3
- [esbuild](https://npm.io/package/esbuild.md) ^0.14.38
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [vue-tsc](https://npm.io/package/vue-tsc.md) ^0.34.10
- [filesize](https://npm.io/package/filesize.md) ^8.0.7
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.1.0
- [prettier](https://npm.io/package/prettier.md) ^2.6.2
- [unconfig](https://npm.io/package/unconfig.md) ^0.3.3
- [clean-css](https://npm.io/package/clean-css.md) ^5.3.0
- [colorette](https://npm.io/package/colorette.md) ^2.0.16
- [commander](https://npm.io/package/commander.md) ^9.2.0
- [klaw-sync](https://npm.io/package/klaw-sync.md) ^6.0.0
- [@vitejs/plugin-vue](https://npm.io/package/@vitejs/plugin-vue.md) ^2.3.1
- [esbuild-plugin-vue](https://npm.io/package/esbuild-plugin-vue.md) ^0.2.4
- [console-table-printer](https://npm.io/package/console-table-printer.md) ^2.11.0
- [rollup-plugin-postcss](https://npm.io/package/rollup-plugin-postcss.md) ^4.0.2

## Recent versions

- 0.0.8 (latest) — 2022-05-02
- 0.0.7 — 2022-05-01
- 0.0.6 — 2022-05-01
- 0.0.5 — 2022-04-27
- 0.0.4 — 2022-04-24
- 0.0.3 — 2022-04-24
- 0.0.2 — 2022-04-17
- 0.0.1 — 2022-04-17

## README

# Astel Cli

CLI tool for astel

## Installation

```sh
yarn add @astel/cli
```

Or

```sh
npm install @astel/cli
```

## Configuration

Astel cli uses a config file `astel.config.ts/js` to detect basic configuration for all commands.

Sample config :

```js
import { defineAstelConfig } from '@astel/cli'

export default defineAstelConfig({
  ignoreDirs: ['.DS_Store', 'utils'],
  build: {
    entry: 'library/index.ts',
    prefix: 'as',
    emptyOutDir: true,
    declaration: true,
    library: [
      { name: 'astel', format: 'esm', outputDir: 'dist/es', bundle: true, summary: true },
      { name: 'astel', format: 'umd', outputDir: 'dist/lib', bundle: true, summary: true },
    ],
  },
})
```

## Commands

### generate

Generate a new component.

Usage :  `npx astel generate <component-name>`

### collect

Collect all component entries and generate `index.ts` entry point for building

### build

Builds the bundle/library according to the configuration in `config.build`

### types

Generate type definitions

## License

[MIT](./LICENSE) License © 2021 [Sumit Kolhe](https://github.com/sumitkolhe)

---
_Source: https://npm.io/package/@astel/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._