File size: 1,395 Bytes
69bcf09
c8b4583
69bcf09
c8b4583
b664dbe
c8b4583
 
bdc1ac8
b664dbe
ec936d5
bdc1ac8
 
64d5fd6
 
 
43ad6b4
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
c8b4583
 
69bcf09
c8b4583
7c3be57
bdc1ac8
43ad6b4
 
 
7c3be57
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# LeRobot.js

> interact with your robot in JS, inspired by [LeRobot](https://github.com/huggingface/lerobot)

## Install

```bash
# Web library
npm install @lerobot/web

# Node.js library
npm install @lerobot/node

# CLI / terminal
npm install -g lerobot
```

## CLI Usage

```
npx lerobot@latest --help
```

->

```
Usage: lerobot [options] [command]

Control your robot with Node.js (inspired by LeRobot in Python)

Options:
  -V, --version                 output the version number
  -h, --help                    display help for command

Commands:
  find-port                     Find robot port with interactive cable detection
  calibrate [options]           Calibrate robot motors
  teleoperate|teleop [options]  Control robot through teleoperation
  release-motors [options]      Release robot motors for manual movement
  help [command]                display help for command
```

## Resources

- **LeRobot.js**: [Introduction post on Hugging Face](https://huggingface.co/blog/NERDDISCO/lerobotjs)
- **Documentation**:
  - [`@lerobot/web`](./packages/web/README.md) - Browser (WebSerial + WebUSB)
  - [`@lerobot/node`](./packages/node/README.md) - Node.js (Serialport)
  - [`lerobot`](./packages/cli/README.md) - CLI / terminal (using `@lerobot/node`)
- **Live Demo**: Try it online at [huggingface.co/spaces/NERDDISCO/LeRobot.js](https://huggingface.co/spaces/NERDDISCO/LeRobot.js)