av-cli

Installation

npm install @mschauer5/av-cli -g

Commands

Create Environment Variable

# Create environment file using {tenantDomain} placeholder
av env

# Create environment file using provided url
av env https://sp.sharepoint.com/sites/test1

Serve

Used with the package.json file scripts 'serve' configuration

This command tries and determines if current project is using pnpm or npm as the package manager.

I highly recommend using spfx-fast-serve

av serve

# The actual commands it calls is one of the below:
- npm run serve
- pnpm run serve

Yo

This is just a short cut for using pnpm manager to create a SharePoint project

av yo

# The actual commands it calls:
yo @microsoft/sharepoint --skip-install --package-manager pnpm

Bundle

This commands grabs the version that is in the package.json file and add that version to the config/package-solution.json and then bundles the solution

av bundle

# The actual commands it calls:
gulp clean
gulp bundle --ship
gulp package-solution --ship

Build

This command runs the build script in the package.json file

av build

# The actual commands it calls:
- npm run build
- pnpm run build

Sync Version

This command copies the package.json version to the config/config/package-solution.json. It also creates a version.json file in the root src folder. Makes it easy to pull version into a webpart.

av sync-version

Commit

This command is used to simplify checking in all your changes and pushing the changes to the remote repo.

av commit [message goes here]

# The actual commands it calls:
git add .
git commit -m [message goes here]
git push

Pull

This command is a short cut for pulling down remote repo.

av pull

# The actual command it calls:
git pull --rebase