Use this index by entrypoint. CLI is for running the packaged tool; API is for embedding retargeting in Python.
| I want to... | Read |
|---|---|
| Install dependencies and verify one run | Getting Started |
| Run from the terminal | CLI Usage |
| Embed retargeting in Python | API Usage |
| Select a hand model or change a YAML config | Configuration |
| Download runtime assets or check model availability | Assets & Models |
| Doc | What it covers |
|---|---|
| Getting Started | Install, assets, first run, optional SDK setup |
| CLI Usage | Terminal commands for live, replay, export, and hardware use |
| API Usage | Stable Python imports, one-step engines, and session hooks |
| Configuration | Which config file to edit and the fields that usually matter |
| Assets & Models | Download commands, local paths, supported config families |
| Maintainer Guide | Docs rules, verification commands, model-update workflow |
The common CLI path is single-hand retargeting. Bi-hand support is for viewer replay/render workflows, and real-hardware control is single-hand only. API users normally provide their own landmark frames and call the engine directly.