Hugging Face's logo

Reachy Mini documentation

Apps

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Apps

Core App Classes

class reachy_mini.ReachyMiniApp

< >

( running_on_wireless: bool = False )

Base class for Reachy Mini applications.

run

< >

( reachy_mini: ReachyMinistop_event: Event )

Parameters

  • reachy_mini (ReachyMini) — The Reachy Mini instance to interact with.
  • stop_event (threading.Event) — An event that can be set to stop the app gracefully.

Run the main logic of the app.

stop

< >

( )

Stop the app gracefully.

wrapped_run

< >

( *args: Any**kwargs: Any )

Wrap the run method with Reachy Mini context management.

class reachy_mini.apps.manager.AppManager

< >

( wireless_version: bool = Falsedesktop_app_daemon: bool = Falsedaemon: typing.Optional[ForwardRef('Daemon')] = None )

Manager for Reachy Mini apps.

close

< >

( )

Clean up the AppManager, stopping any running app.

current_app_status

< >

( )

Get the current status of the app.

install_new_app

< >

( app: AppInfologger: Logger )

Install a new app by name.

is_app_running

< >

( )

Check if an app is currently running or stopping.

list_all_available_apps

< >

( )

List available apps while preserving curated-only entries.

list_available_apps

< >

( source: SourceKind )

List available apps for given source kind.

remove_app

< >

( app_name: strlogger: Logger )

Remove an installed app by name.

restart_current_app

< >

( )

Restart the current app.

start_app

< >

( app_name: str*args: Anyevict_remote: bool = True**kwargs: Any )

Start the app as a subprocess.

Raises RuntimeError if an app is already running. When evict_remote is false, a remote WebRTC session holding the app slot makes the start fail instead of being evicted.

stop_current_app

< >

( timeout: float | None = 20.0 )

Stop the current app subprocess.

update_app

< >

( app_name: strlogger: Logger )

Parameters

  • app_name — Name of the app to update.
  • logger — Logger for progress output.

Raises

RuntimeError

  • RuntimeError — If app is running, not found, or update fails.

Update an installed app by reinstalling it from HuggingFace.

This preserves the original source info and reinstalls to get the latest version.

App Management

class reachy_mini.apps.manager.AppState

< >

( valuenames = Nonemodule = Nonequalname = Nonetype = Nonestart = 1boundary = None )

Status of a running app.

class reachy_mini.apps.manager.AppStatus

< >

( info: AppInfostate: AppStateerror: str | None = None )

Status of an app.

class reachy_mini.apps.manager.RunningApp

< >

( process: Processmonitor_task: Taskstatus: AppStatus )

Information about a running app.

App Information

class reachy_mini.apps.AppInfo

< >

( name: strsource_kind: SourceKinddescription: str = ''url: str | None = Noneextra: typing.Dict[str, typing.Any] = <factory> )

Metadata about an app.

class reachy_mini.apps.SourceKind

< >

( valuenames = Nonemodule = Nonequalname = Nonetype = Nonestart = 1boundary = None )

Kinds of app source.

App Assistant

Assistant Functions

reachy_mini.apps.assistant.validate_app_name

< >

( text: str )

Validate the app name.

reachy_mini.apps.assistant.is_git_repo

< >

( path: Path )

Check if the given path is inside a git repository.

reachy_mini.apps.assistant.validate_location

< >

( text: str )

Validate the location where to create the app project.

reachy_mini.apps.assistant.validate_location_and_git_repo

< >

( text: str )

Validate the location where to create the app project, ensuring it’s not in a git repo.

reachy_mini.apps.assistant.create_cli

< >

( console: Consoleapp_name: str | Noneapp_path: pathlib.Path | None )

Create a new Reachy Mini app project using a CLI.

reachy_mini.apps.assistant.create

< >

( console: Consoleapp_name: strapp_path: Path ) → Path

Parameters

  • console (Console) — The console object for printing messages.
  • app_name (str) — The name of the app to create.
  • app_path (Path) — The directory where the app project will be created.

Returns

Path

The path to the created app project.

Create a new Reachy Mini app project with the given name at the specified path.

reachy_mini.apps.assistant.install_app_with_progress

< >

( console: Consolepython_executable: strapp_path: Pathenv: dict[str, str] | None = None )

Install the app in a temporary virtual environment with a progress spinner.

reachy_mini.apps.assistant.check

< >

( console: Consoleapp_path: str )

Parameters

  • console (Console) — The console object for printing messages.
  • app_path (str) — Local path to the app to check.

Check an existing Reachy Mini app project.

reachy_mini.apps.assistant.request_app_addition

< >

( new_app_repo_id: str )

Request to add the new app to the official Reachy Mini app store.

reachy_mini.apps.assistant.try_to_push

< >

( console: Console_app_path: Path )

Try to push changes to the remote repository.

reachy_mini.apps.assistant.publish

< >

( console: Consoleapp_path: strcommit_message: strofficial: bool = Falseno_check: bool = Falseprivate: bool | None = None )

Parameters

  • console (Console) — The console object for printing messages.
  • app_path (str) — Local path to the app to publish.
  • commit_message (str) — Commit message for the app publish.
  • official (bool) — Request to publish the app as an official Reachy Mini app.
  • no_check (bool) — Don’t run checks before publishing the app.
  • private (bool | None) — If True, make private. If False, make public. If None, prompt.

Publish the app to the Reachy Mini app store.

App Sources

reachy_mini.apps.sources.hf_auth.save_hf_token

< >

( token: str ) → A dict containing

Parameters

  • token — The HuggingFace access token to save.

Returns

A dict containing

  • “status”: “success” or “error”
  • “username”: the associated Hugging Face username if successful
  • “message”: an error description if unsuccessful

Save a HuggingFace access token securely.

Validates the token against the Hugging Face API and, if valid, stores it using the standard Hugging Face authentication mechanism for reuse across sessions.

reachy_mini.apps.sources.hf_auth.get_hf_token

< >

( )

Get stored HuggingFace token.

reachy_mini.apps.sources.hf_auth.delete_hf_token

< >

( )

Delete stored HuggingFace token(s).

Note: logout() without arguments logs out from all saved access tokens.

reachy_mini.apps.sources.hf_auth.check_token_status

< >

( )

Check if a token is stored and valid.

reachy_mini.apps.sources.hf_space.list_available_apps

< >

( )

List apps available on Hugging Face Spaces.

reachy_mini.apps.sources.hf_space.list_all_apps

< >

( )

List all apps available on Hugging Face Spaces (including private ones when authenticated).

reachy_mini.apps.sources.local_common_venv.get_app_site_packages

< >

( app_name: strwireless_version: bool = Falsedesktop_app_daemon: bool = False )

Public API to get the site-packages directory for a given app’s venv.

For separate venvs: returns the app’s venv site-packages For shared environment (SDK mode): returns the current environment’s site-packages

reachy_mini.apps.sources.local_common_venv.get_app_python

< >

( app_name: strwireless_version: bool = Falsedesktop_app_daemon: bool = False )

Get the Python executable path for an app (cross-platform).

For separate venvs: returns the app’s venv Python For shared environment: returns the current Python interpreter

reachy_mini.apps.sources.local_common_venv.list_available_apps

< >

( wireless_version: bool = Falsedesktop_app_daemon: bool = False )

List apps available from entry points or separate venvs.

reachy_mini.apps.sources.local_common_venv.install_package

< >

( app: AppInfologger: Loggerwireless_version: bool = Falsedesktop_app_daemon: bool = Falseforce_reinstall: bool = False )

Parameters

  • app — AppInfo with package details.
  • logger — Logger for progress output.
  • wireless_version — Whether running on wireless version.
  • desktop_app_daemon — Whether running as desktop app daemon.
  • force_reinstall — If True, force reinstall even if already installed (for updates).

Install a package given an AppInfo object, streaming logs.

reachy_mini.apps.sources.local_common_venv.get_app_module

< >

( app_name: strwireless_version: bool = Falsedesktop_app_daemon: bool = False )

Get the module name for an app without loading it (for subprocess execution).

reachy_mini.apps.sources.local_common_venv.uninstall_package

< >

( app_name: strlogger: Loggerwireless_version: bool = Falsedesktop_app_daemon: bool = False )

Uninstall a package given an app name.

App Utilities

reachy_mini.apps.utils.running_command

< >

( command: listlogger: Loggerenv: dict[str, str] | None = None )

Parameters

  • command — The command to run as a list of strings.
  • logger — Logger instance for output streaming.
  • env — Optional environment variables dict. If None, inherits current environment.

Run a shell command and stream its output to the provided logger.

Update on GitHub

←Utils Daemon→