robits.cli package

Command-line interface for the RoBits robotic manipulation library.

This package provides a comprehensive CLI for controlling robots, cameras, and grippers, as well as managing datasets and configurations. The CLI is built on Click with Rich enhancements for a modern terminal experience.

Key command groups:

• robot: General robot information and control

• move: Robot movement operations

• camera: Camera control and visualization

• gripper: Gripper control

• dataset: Dataset management and replay

• config: Configuration management

• speech: Speech recognition and synthesis

Usage:

$ rb --help                    # Show main help
$ rb move --help               # Show move command help
$ rb move up --robot-name ...  # Move robot upward

Subpackages

• robits.cli.agents namespace
  • Submodules
  • robits.cli.agents.mello_cli module
  • robits.cli.agents.sam2act_cli module
• robits.cli.commands namespace
  • Submodules
  • robits.cli.commands.config_cli module
  • robits.cli.commands.dataset_cli module
  • robits.cli.commands.move_cli module
  • robits.cli.commands.scene_visu module
  • robits.cli.commands.service_cli module
    • get_running_services()
  • robits.cli.commands.speech_cli module
• robits.cli.devices namespace
  • Submodules
  • robits.cli.devices.camera_cli module
  • robits.cli.devices.gripper_cli module
  • robits.cli.devices.panda_cli module
  • robits.cli.devices.robot_cli module

Submodules

robits.cli.base_cli module

Base module for RoBits command-line interface.

This module provides the foundation for all CLI commands in RoBits. It sets up the base command group, configures logging with Rich formatting, and provides global verbosity controls.

robits.cli.cli_options module

robits.cli.cli_options.build_robot_from_param(ctx, param, value)

robits.cli.cli_options.robot(*args, **kwargs)

robits.cli.cli_utils module

robits.cli.cli_utils.prompt_for_action(robot, action, use_hands=True, num_attempts=10)

robits.cli.cli_utils.setup_cli(level: str | int = 20, force: bool = True)

robits.cli.main module

Main entry point for the RoBits command-line interface.

This module imports and assembles all CLI command groups, making them available through the ‘rb’ entry point. New command modules should be imported here to be included in the CLI.