System Requirements
Runtime
Node.js ≥ 18.0 or Python ≥ 3.9
Package Manager
npm, yarn, pip, or brew
Git
git ≥ 2.30 for repository sync
Disk Space
~250MB for CLI + base templates
Install Webui
Terminal
$ npm install -g @webui/cli
1
Verify Installation
Run webui --version to confirm the CLI is globally available.
2
Initialize Project
Execute webui init my-project to scaffold your workspace.
Terminal
$ pip3 install --user webui
# Add to PATH if not automatically configured:
$ export PATH="$PATH:~/.local/bin"
Terminal
$ brew tap webui/tap && brew install webui
Troubleshooting
This usually means the installation directory isn't in your system
For npm: Run
For pip: Add
PATH.For npm: Run
npm config get prefix and ensure the bin folder is exported.For pip: Add
~/.local/bin to your ~/.bashrc or ~/.zshrc and run source ~/.bashrc.
Avoid using
Then add
sudo for npm global installs. Instead, configure npm to use a user-owned directory:mkdir ~/.npm-globalnpm config set prefix '~/.npm-global'Then add
export PATH=~/.npm-global/bin:$PATH to your shell profile.
Webui requires Node 18+. If you have an older version, use a version manager like
Then retry the installation command. You can verify with
nvm:nvm install 18 && nvm use 18Then retry the installation command. You can verify with
node -v.