Skip to main content

The AI-ready robotics dev kit, with built-in remote control and VLA support.

Project description

phosphobot

phosphobot – CLI Toolkit for Robot Teleoperation and Action Models PyPI version GitHub Discord

A simple, community-driven middleware for controlling robots, recording datasets, training action models.

All from your terminal or browser dashboard.

Features

  • Easy Installation: python module
  • Web Dashboard: Instant access to an interactive control panel for teleoperation
  • Dataset Recording: Record expert demonstrations with a keyboard, in VR, or with a leader arm
  • Model Training & Inference: Kick off training jobs or serve models through HTTP/WebSocket APIs

phosphobot installation

Install the compiled version

Check out our compiled versions for installation on MacOS, Windows, and Linux without thinking about Python versions.

Install the python module

We recommend using uv:

# Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Add phosphobot to your project
uv add phosphobot

You can also use pip.

pip install phosphobot

Install from source

For development or if you face issues with some submodule or version, you can install phosphobot from source.

  1. Clone the phosphobot repo. Make sure you have git lfs installed beforehand.

    git clone https://github.com/phospho-app/phosphobot.git --depth 1
    
  2. Install uv to manage python dependencies. The recommended python version for dev is 3.10

    curl -LsSf https://astral.sh/uv/install.sh | sh
    

    Then restart your terminal and verify that uv is in your path.

    uv --version # should output: uv 0.7.10
    
  3. Install nvm and Node.js. We recommend to manage Node versions via nvm.

    # Install nvm
    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
    

    Then restart your terminal and verify:

    command -v nvm   # should output: nvm
    

    Finally, install the latest Node.js:

    nvm install node   # “node” is an alias for the latest version
    
  4. Build the app. (Linux and MacOS) From the root of the repo, run:

    make
    

    Which is a shortcut for the following two commands. First, build frontend:

    cd ./dashboard && ((npm i && npm run build && mkdir -p ../phosphobot/resources/dist/ && cp -r ./dist/* ../phosphobot/resources/dist/) || echo "npm command failed, continuing anyway")
    

    Then, build backend:

    cd phosphobot && uv run phosphobot run --simulation=headless
    

Troubleshooting: pybullet won't build on Windows

You may encounter the error: error: Microsoft Visual C++ 14.0 is required. Get it with "Microsoft Visual C++ Build Tools

If so, you need to install Visual Studio and the Microsoft C++ v14 tools (it's the first item in the list of additional downloads, should be called C++ build tools for Windows).

Troubleshooting: pybullet won't compile on MacOS Silicon

This is a recurring issue with Mac Silicon (M1, M2, M3, M4, etc.) linked to pybullet.

  1. Make sure you followed all the previous instructions in Install from source until you had the pybullet compilation error.

  2. Sync submodules to get the patched version of pybullet. This should add files in the bullet3 folder.

git submodule update --init --depth 1

This adds a forked version of pybullet with a modified examples/ThirdPartyLibs/zlib/zutil.h to comments the lines with #define fdopen(fd, mode) NULL that break pybullet compilation on some verisons of MacOS.

  1. Go to the root of this github repo. Enable the python environment created by uv
source phosphobot/.venv/bin/activate
  1. With the environment active, build and install pybullet using setup.py

    cd bullet3
    python setup.py build
    python setup.py install
    

    Note: If you installed the XCode app, you may need to set the following flags to make the pybullet compilation work.

    export LDFLAGS="-L/Library/Frameworks/Python.framework/Versions/3.10/1ib"
    export CPPFLAGS="-I/Library/Frameworks/Python.framework/Versions/3.10/include/python3.10"
    export CPFLAGS="$CPPFLAGS"
    
  2. Edit the phosphobot/pyproject.toml to uncomment the following line:

[tool.uv.sources]
# Troubleshooting: on MacOS Silicon, you may need to compile pybullet from source.
# If so, follow the guide in the README.md file and uncomment the line below.
pybullet = { path = "../bullet3", editable = true } # <-- uncomment!

(Optionnal) Also edit phosphobot/simulation/pybullet/pyproject.tomlto uncomment the following line if you want to use the make prod_gui command

[tool.uv.sources]
# Troubleshooting: on MacOS Silicon, you may need to compile pybullet from source.
# If so, follow the guide in the README.md file and uncomment the line below to run make prod_gui
pybullet = { path = "../../../phosphobot/bullet3", editable = true } # <-- uncomment!
  1. Run make again. You should now see logs similar to this. Note that the pybullet version is now tagged as phospho version. The date and time should also match.
      Built pybullet @ file:///Users/nicolasoulianov/robots/robots/phospho
      Built phosphobot @ file:///Users/nicolasoulianov/robot
Uninstalled 3 packages in 276ms
Installed 2 packages in 2ms
2025-07-16 23:04:07.468 | INFO     | phosphobot.main:<module>:4 - Starting phosphobot...
sys.stdout.encoding = utf-8

    ░█▀█░█░█░█▀█░█▀▀░█▀█░█░█░█▀█░█▀▄░█▀█░▀█▀
    ░█▀▀░█▀█░█░█░▀▀█░█▀▀░█▀█░█░█░█▀▄░█░█░░█░
    ░▀░░░▀░▀░▀▀▀░▀▀▀░▀░░░▀░▀░▀▀▀░▀▀░░▀▀▀░░▀░

    phosphobot 0.3.61
    Copyright (c) 2025 phospho https://phospho.ai

2025-07-16 23:04:08.399 | DEBUG    | phosphobot.utils:get_tokens:354 - Loaded dev tokens
pybullet build time: Jul 16 2025 23:03:57 (phospho version)

Dashboard & Control

After launching the server, open your browser and navigate to:

http://<YOUR_SERVER_ADDRESS>:<PORT>/

By default, the address is localhost:80

Here you can:

  • Teleoperate your robot via keyboard, leader arm, or Meta Quest
  • Record demonstration datasets (40 episodes recommended)
  • Train and deploy action models directly from the UI

Adding a New Robot

You can extend phosphobot by plugging in support for any custom robot. Just follow these steps to install phosphobot from source on any OS:

  1. Install phosphobot from source (see instructions just above)

  2. Run phosphobot with simulation GUI When running phosphobot, use the --simulation=gui flag to display the pybullet GUI in a new window. This way, you can check if keyboard control and VR control actually work in simulation before trying it on hardware.

  3. Use the URDF Loader to try you robot. phosphobot uses pybullet (docs) as a robotics simulation backend.

    In PyBullet, the 3D representation, geometry and constraints of a robot is called a URDF. You can create a first version of the URDF of your robot by finding one online (usually: exported from a CAD software) or writing your own (it's just a XML file with some conventions). We recommend you work on that with ChatGPT or Gemini 2.5 Pro. There are different variations of the URDF file, so make sure yours is compatible with pybullet.

    To load the URDF, click on the robot status icon, then Add a robot, and finally use the URDF loader. Check out this video on how to do that.. You should see the robot appear in the simulation window.

    Pay attention to the ways the joints bends and the limits set in the urdf. Make sure to iterate until it's sensible.

    When you're satisfied with your urdf, add it to phosphobot/resources/urdf.

  4. Create your robot driver

    In the directory phosphobot/phosphobot/hardware add a new file, e.g. my_robot.py. Inside, define a class inheriting from BaseRobot:

    from phosphobot.hardware.base import BaseRobot
    
    class MyRobot(BaseRobot):
        def __init__(self, config):
            super().__init__(config)
            # Your initialization here
    
        ... # Implement the BaseRobot's abstract methods here
    
  5. Make your robot detectable Open phosphobot/phosphobot/robot.py and locate the RobotConnectionManager class. Make sure your robot can be detected.

    As an alternative, when running phosphobot, use the --only-simulation flag and config.ONLY_SIMULATION to force the RobotConnectionManager to detect your robot, even if it's not connected to hardware. You'll need to change the RobotConnectionManager so that it's actually your robot that gets loaded.

  6. Try on a real robot. How you connect to the robot and make it move depends directly on your hardware. Look for python library from the manufacturer. Some general advice: go step by step, don't make any drastic movements, check what values you send to the motors before writing to them, keep your robot near mattresses if ever it falls, keep it away from pets, children, or expensive furniture.

Build and run the app again and ensure your robot gets detected and can be moved. Happy with your changes? Open a pull request! We also recommend you look for testers on our Discord.

Start building

License

MIT License

Made with 💚 by the Phospho community.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

phosphobot-0.3.120.tar.gz (13.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

phosphobot-0.3.120-py3-none-any.whl (13.9 MB view details)

Uploaded Python 3

File details

Details for the file phosphobot-0.3.120.tar.gz.

File metadata

  • Download URL: phosphobot-0.3.120.tar.gz
  • Upload date:
  • Size: 13.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.17

File hashes

Hashes for phosphobot-0.3.120.tar.gz
Algorithm Hash digest
SHA256 5d2d22fd18225286689cf3172915dd2af84f4821643bca1e3bef4fb1a711bce5
MD5 4e8c1145eccb4d6540b6ffea06842e28
BLAKE2b-256 3c593cd343ab3ba52391b7cefc580a05efae4b806bd3ce021510fd816c61fc0a

See more details on using hashes here.

File details

Details for the file phosphobot-0.3.120-py3-none-any.whl.

File metadata

File hashes

Hashes for phosphobot-0.3.120-py3-none-any.whl
Algorithm Hash digest
SHA256 e3e4f7b15978c5ea3b6715d60a4ab1beade93817a8fe0198399e13868370cda4
MD5 87f5c5c4c1435d999336854139c21842
BLAKE2b-256 b997b79aefcbe42691cbcb15d8be2c3d82bc99ebd4c7cfd6138d414f69c70674

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page