Action-cli NPM

Action-cli

NPM Downloads

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

⚡ Installation

# global install
npm install -g action-cli

🚀 Usage

Create

Create a new project:

# create a new project
action create demo

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

# 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:

# open the web-based UI
action ui

Template

Show available templates:

# list available templates
action list

Add or remove a template:

# 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:

# update action-cli
action update

Help

show help:

# 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 \	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 \ \	Add a new template	-	-
remove \	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

Repository

Topskys/action-cli

🛠️ Run

Development

# 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