This document covers the environment preparation and installation steps for BMC Studio.

Environment Setup ​

BMC Studio uses the same environment as openUBMC, please make sure your development environment is ready. For guidance, please follow openUBMC Environment Setup.

You'll likely need git and the bingo tool during the process, so ensure they're installed on your system.

Runtime Environment ​

OS requirement: Ubuntu 24.04.

Installation ​

There are three ways to install BMC Studio, please choose the one you prefer.

Option 1: Automatic Upgrade and Installation via bingo (Recommended) ​

BMC Studio shall be installed automatically when you installing openUBMC from manifest.

If you already have BMC Studio installed, just run this command to bump it to the latest version:

bingo upgrade

Option 2: Installation from the App Marketplace ​

1. Go to the openUBMC Marketplace, head to the "Development Tools" section, and select "BMC Studio".
2. On the BMC Studio download page, click "Download Now" on the right to grab the package locally.
3. Follow the installation instructions on that page to set it up.

Option 3: Manual Installation via Apt Repository (Cangjie Toolchain and BMC Studio) ​

1. Check if the apt repository is already configured:

   bash

   sudo apt update
   apt policy openubmc-bingo

   If you see output like this, the repo is set up, jump to step 5.

   bash

   openubmc-bingo:
   Installed: 0.0.1
   Candidate: 0.0.1
   Version table:
   0.0.1 500
   500 https://openubmc-apt-repo.obs.cn-north-4.myhuaweicloud.com/Ubuntu noble/main amd64 Packages

   Otherwise, continue with the next steps.

2. Download the GPG public key

   1. Install gnupg if needed

      bash

      sudo apt update && sudo apt install gnupg

   2. Add the GPG key

      • Option 1: Direct download

        1. Create the keyrings directory:

           bash

           sudo mkdir -p /etc/apt/keyrings

        2. Download and install the key:

           bash

           wget -O- https://openubmc-apt-repo.obs.cn-north-4.myhuaweicloud.com/Ubuntu/gpg_key.public | sudo gpg --dearmor -o /etc/apt/keyrings/openubmc.gpg

      • Option 2: From keyserver

        1. Create the keyrings directory:

           bash

           sudo mkdir -p /etc/apt/keyrings

        2. Fetch and add the key:

           bash

           gpg --keyserver keyserver.ubuntu.com --recv-keys BF3B2D407FDEDEA0DC91CC9412640FBCB175287A
           gpg --export BF3B2D407FDEDEA0DC91CC9412640FBCB175287A | sudo tee /etc/apt/keyrings/openubmc.gpg >/dev/null

3. Add the apt repository:

   bash

   echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/openubmc.gpg] https://openubmc-apt-repo.obs.cn-north-4.myhuaweicloud.com/Ubuntu/ noble main" | sudo tee /etc/apt/sources.list.d/openubmc.list

4. Verify the configuration:

   bash

   sudo apt update
   apt policy bmc-studio

5. Install the Cangjie runtime package and BMC Studio:

   bash

   apt remove bmc-studio
   apt install cangjie-runtime
   apt install bmc-studio

Launching BMC Studio ​

If you have the BMC Studio VS Code extension, just click it to launch inside VS Code.

If you've installed bingo (version 0.5.238 or newer), run this to start it:

bingo studio

• On WSL, the frontend page should open directly in your browser.

• On non-WSL setups, manually open the address shown in the backend logs (it varies by system).Manually opening BMC Studio:

  bash

  /usr/share/bmc_studio/bmc_studio.sh start
  /usr/share/bmc_studio/bmc_studio.sh start backend（后台启动）

Common Commands ​

Via bingo ​

Start BMC Studio ​

bingo studio

Stop BMC Studio ​

bingo studio -stop

Restart BMC Studio ​

bingo studio -restart

Via BMC Studio scripts ​

Start BMC Studio ​

/usr/share/bmc_studio/bmc_studio.sh start
/usr/share/bmc_studio/bmc_studio.sh start backend（后台启动）

Stop BMC Studio ​

/usr/share/bmc_studio/bmc_studio.sh stop

Restart BMC Studio ​

/usr/share/bmc_studio/bmc_studio.sh restart

Troubleshooting ​

Check the BMC Studio FAQ for common issues.