Skip to main content

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

Project description

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 via pip or the uv package manager
  • 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

Installation

1. Using pip

pip install phosphobot

2. Using uv

If you already use uv to manage Python versions and deps:

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

# Add phosphobot to your project
uv add phosphobot

Quick Start

Once installed, you can start the phosphobot server instantly.

# Verify installation and view info
phosphobot info

# Start the teleoperation server (default: localhost:80)
phosphobot run

# For custom port, e.g. 8080
phosphobot run --port 8080

If you’re managing via uv:

uv run phosphobot info
uv run phosphobot run

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

Start building


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. Clone the phosphobot repo and fetch submodules. Make sure you have git lfs installed beforehand

    git clone https://github.com/phospho-app/phosphobot.git
    cd phosphobot
    git submodule update --init --recursive
    
  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 command:

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

    On Windows, run the full command to build the app.

  5. Create your robot driver

    1. 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
      

      We use pybullet (docs) as a robotics simulation backend. Make sure to add your robot's urdf in phosphobot/resources/urdf.

  6. Make your robot detectable Open phosphobot/phosphobot/robot.py and locate the RobotConnectionManager class. Make sure your robot can be detected.

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.


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.47.tar.gz (14.2 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.47-py3-none-any.whl (14.3 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for phosphobot-0.3.47.tar.gz
Algorithm Hash digest
SHA256 3f3a0c97b26da2c9baff7968945ef1b45aa5dc13d8304c4acf7d73d8fe426415
MD5 c18a061cd6752a878f04fe9abd69429c
BLAKE2b-256 f6db0e5884d1f1942c0c2a980b35abf48f33c94c3bff0b6c27c62ed5e9c58dce

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for phosphobot-0.3.47-py3-none-any.whl
Algorithm Hash digest
SHA256 2cb6d5a231edb6c3df18dc881d8946617cb08f14a61ddd99f4af7565b8e63eab
MD5 33cd9d553762802215b53aca466b0f72
BLAKE2b-256 f90ff6a1aa5e7ccb452c16c25fb69ab0030d50d81657319fe55c9ccc120c3902

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