Installation

Learn how to install and set up ShadPanel in your development environment.

Prerequisites

Before installing ShadPanel, ensure you have the following:

Install ShadPanel globally to use it anywhere:


npm install -g shadpanel

Verify the installation:


shadpanel --version

Use ShadPanel without installing it globally:


shadpanel init my-app

You can also use the create package directly:


npx create-shadpanel-next my-app

This is an alternative entry point that provides the same functionality.

ShadPanel supports all major Node.js package managers:


npm install -g shadpanel
shadpanel init my-app


pnpm add -g shadpanel
shadpanel init my-app --use-pnpm


yarn global add shadpanel
shadpanel init my-app --use-yarn


bun add -g shadpanel
shadpanel init my-app --use-bun

After installation, verify that ShadPanel is working:


# Check version
shadpanel --version
 
# Get help
shadpanel --help
 
# List all commands
shadpanel init --help

Update to the latest version:


npm update -g shadpanel

Or with other package managers:


# pnpm
pnpm update -g shadpanel
 
# yarn
yarn global upgrade shadpanel
 
# bun
bun update -g shadpanel

Check if a newer version is available:


npm outdated -g shadpanel

If you need to remove ShadPanel:


# npm
npm uninstall -g shadpanel
 
# pnpm
pnpm remove -g shadpanel
 
# yarn
yarn global remove shadpanel
 
# bun
bun remove -g shadpanel

Now that ShadPanel is installed, you’re ready to create your first project: