# action-cli

> Action-cli is a CLI focused on powering the start of developer's web project.

Latest version **1.1.0** (published 2024-11-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install action-cli
pnpm add action-cli
yarn add action-cli
bun add action-cli
```

Provides the command `action`.

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2024-11-17 |
| First published | 2024-03-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 19.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Topskys |
| Maintainers | loranbo |
| Keywords | cli, action-cli, vue, react, nestjs, fullstack, typescript, nodejs |

## Links

- npm: https://www.npmjs.com/package/action-cli
- Repository: https://github.com/Topskys/action-cli
- Homepage: https://github.com/Topskys/action-cli#readme
- Issues: https://github.com/Topskys/action-cli/issues
- npm.io page: https://npm.io/package/action-cli

## Dependencies (9)

- [ora](https://npm.io/package/ora.md) ^5.0.0
- [axios](https://npm.io/package/axios.md) ^1.6.7
- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [figlet](https://npm.io/package/figlet.md) ^1.7.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.2.0
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.1
- [commander](https://npm.io/package/commander.md) ^12.0.0
- [simple-git](https://npm.io/package/simple-git.md) ^3.27.0
- [progress-estimator](https://npm.io/package/progress-estimator.md) ^0.3.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2024-11-17
- 1.0.7 — 2024-03-15
- 1.0.6 — 2024-03-15
- 1.0.5 — 2024-03-13
- 1.0.4 — 2024-03-10
- 1.0.3 — 2024-03-09
- 1.0.2 — 2024-03-09
- 1.0.1 — 2024-03-09
- 1.0.0 — 2024-03-09

## README

# Action-cli

![NPM Version](https://img.shields.io/badge/action-cli_v1.1.0-green)
![NPM Downloads](https://img.shields.io/npm/dy/action-cli)


[![NPM](https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white)](https://www.npmjs.com/package/action-cli)
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/Topskys/action-cli)

Action-cli is a CLI focused on powering the start of developer's web  project.

## ⚡ Installation
```sh
# global install
npm install -g action-cli
```

## 🚀 Usage

**Create**

Create a new project:
```sh
# create a new project
action create demo

```
Your can create a new project with the template of your choice:

```sh
# create a new project with the react template
action create demo --template react
# or
action create demo --template https://github.com/demo/react-admin-template.git

```

You can use the web-based UI to create a new project:
```sh
# open the web-based UI
action ui
```
**Template**

Show available templates:
```sh
# list available templates
action list
```
Add or remove a template:

```sh
# add a new template
action add vue-ts https://github.com/demo/vue-admin-template.git

# remove an existing template
action remove vue-ts
```

**Update**

When a new version is detected, you can use this command to update the scaffolding.
update action-cli:
```sh
# update action-cli
action update
```

**Help**

show help:
```sh
# show help
action help

# show help for command
action help create
```

## ✨ Changelog

- Refactor the create command

- Add features to the create command including branching, package manager, automatic execution, and custom commands

- Refactor the list command

- Refactor the template command

- Add the update command, which supports detecting scaffolding version updates

- Optimize packaging


## ✨ Features


| command	| description	| option	| description |
| ------------ | ------------ | ------------ | ------------ |
| create \<project-name> | Create a project |-t, --template [template-name]	| template or git-url（string）|
|    |  | 	-f, --force	|Overwrite target directory if it exists|
|    |  |-b, --branch [branch-name]	| Specify a branch to clone |
|    |  |-r, --run	| Run the project after creation |
|    |  |-c, --command [command]	| Specify a command to run |
|    |  |-pm, --packageManager [package-manager]	| Specify a package manager to use |
| list |	List available templates |	-	| - |
| add \<template-name> \<template-url> |	Add a new template	| - |	- |
| remove \<template-name> | Remove an existing template	| - |	- |
| update | Update the cli to the latest version	| - |	- |
| ui	| Open the web-based UI |	-p, --port [port]	|Specify port (number)|
|-| -|-h,  --host [host]	| Specify hostname (string)|
|-	|-|	-V，--version	|Display version number|
|-|-|-h，--help	|Display available CLI options|
| help [command]	|Display help for command|	--help	|Display help for command|
| ...|	-|	-|	-|


## Screenshots


![p1](https://i-blog.csdnimg.cn/direct/a631c6eb655a4264a50e3e6c5ca441ef.png)
![p2](https://i-blog.csdnimg.cn/direct/1d11d6f350494af5b9e12fee611c217f.png)
![p3](https://i-blog.csdnimg.cn/direct/f05b396c2a8141c7a9771d1afbaceda0.png)


## Repository

[Topskys/action-cli](https://github.com/Topskys/action-cli)

## 🛠️ Run

Development
```sh
# clone repo
git clone https://github.com/Topskys/action-cli.git

# install dependencies
pnpm install

# transform
pnpm run build

# global link
pnpm link

# todo
action create demo
```

## Blog

[实现一个自定义前端脚手架_前端自定义脚手架-CSDN博客](https://blog.csdn.net/qq_58062502/article/details/136307480?fromshare=blogdetail&sharetype=blogdetail&sharerId=136307480&sharerefer=PC&sharesource=qq_58062502&sharefrom=from_link)

## Thanks

[【前端脚手架】实现一个自己的脚手架](https://www.bilibili.com/video/BV1PB4y1j7DY/?p=7&share_source=copy_web&vd_source=d50c6b3216dda73ea5961ad06d492fa2)

[【手把手教你实现前端脚手架】](https://www.bilibili.com/video/BV14o4y1T7Ra/?share_source=copy_web&vd_source=d50c6b3216dda73ea5961ad06d492fa2)

[【nebula-cli-frontend】](https://www.npmjs.com/package/nebula-cli-frontend)

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