Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

68 lines (49 loc) · 1.34 KB

Installation

# npm
npm install @vbs/magic-cli-core -g

# yarn
yarn global add @vbs/magic-cli-core

# pnpm
pnpm install --global @vbs/magic-cli-core

Development starts

# install rush
npm install -g @microsoft/rush

git clone https://github.com/vbs-plus/magic-cl

npm run bootstrap
npm run dev && npm run link 

# Check out the bin effect
magic -h

Development environment debugging

npm run dev && npm run link

Production environment packaging

# Global packaging
rush build

# Subcontracted packaging
rush build -o @vbs/magic-cli-core

# Dependent package packaging
rush build -i @vbs/magic-cli-utils

Posted (powered by Github Action)

npm run release

Configure claims

# The global env file holds path ex:/Users/xxx/.magic-cli.env
homeEnvPath
# Default global installation directory, tp is not specified to take effect ex:/Users/xxx/.magic-cli
process.env.MAGIC_CLI_HOME_PATH
# Assist in stitching the global cache directory ex:.magic-cli
process.env.MAGIC_HOME_PATH
# Specify the root directory where the command (init) file is located, which is empty by default, and go to the global installation directory ec: /users/target/xxx
process.env.TARGET_PATH
# Turn on Debug mode, turn off by default, and turn on ec: debug by adding the command parameter -d
process.env.DEBUG