Imperal Docs
Webbee Code

Install Webbee Code

Install Webbee Code with pipx on macOS, Linux, or Windows, run it, and sign in with a short device code.

Getting Webbee Code onto your machine takes two steps: install it, then sign in. It runs anywhere you have Python 3 — macOS, Linux, or Windows.

Install

Webbee Code is a Python command-line tool, published on PyPI as webbee. The clean way to install a CLI tool is with pipx — it keeps webbee in its own isolated environment and on your PATH, so it never clashes with your projects' Python packages. (Plain pip install webbee works too, but pipx is the tidy, recommended way.)

First you'll need Python 3. If you don't have it yet, the SDK install page walks through it for each OS.

1. Install pipx

Already have pipx? Skip to step 2.

The easiest way is with Homebrew:

brew install pipx
pipx ensurepath

No Homebrew? Use Python's own pip:

python3 -m pip install --user pipx
python3 -m pipx ensurepath

Ubuntu / Debian:

sudo apt update && sudo apt install -y pipx
pipx ensurepath

Fedora:

sudo dnf install pipx
pipx ensurepath

Arch:

sudo pacman -S python-pipx
pipx ensurepath

Any other distro — install it through pip:

python3 -m pip install --user pipx
python3 -m pipx ensurepath

With Python from python.org (tick "Add Python to PATH" when installing):

python -m pip install --user pipx
python -m pipx ensurepath

Prefer Scoop?

scoop install pipx
pipx ensurepath

Restart your shell after ensurepath

pipx ensurepath adds pipx's bin folder to your PATH. Open a new terminal (or run source ~/.zshrc / source ~/.bashrc) so the webbee command is found.

2. Install Webbee Code

With pipx ready, the install is identical on every system:

pipx install webbee

Start it any time by typing:

webbee

When a new version ships, upgrade to the latest:

pipx upgrade webbee

Sign in

The first time you run webbee, it'll ask you to sign in. Webbee Code uses device-code login — the same single Imperal sign-in every surface uses.

Here's how it goes:

  1. Run webbee. It shows you a short code and a URL.
  2. Open that URL in your browser.
  3. Enter the code and approve the sign-in.
  4. Back in your terminal, Webbee signs in on its own.

That's it. One login covers every surface — the panel, the terminal, and connectors all share the same session. You won't juggle separate credentials.

You'll need a paid plan

Webbee Code requires a paid plan — Pro or higher. If you try to use it without one, Webbee tells you to upgrade at panel.imperal.io.

Once you're signed in and on a paid plan, you're ready to go. Head over to Using Webbee Code to learn the commands and how to steer a running turn.

On this page