Spaces:
Running
Running
docs: more cli; concise resources
Browse files
README.md
CHANGED
|
@@ -13,15 +13,38 @@ npm install @lerobot/node
|
|
| 13 |
|
| 14 |
# CLI / terminal
|
| 15 |
npm install -g lerobot
|
| 16 |
-
|
| 17 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 18 |
```
|
| 19 |
|
| 20 |
## Resources
|
| 21 |
|
| 22 |
- **LeRobot.js**: [Introduction post on Hugging Face](https://huggingface.co/blog/NERDDISCO/lerobotjs)
|
| 23 |
- **Documentation**:
|
| 24 |
-
- [`@lerobot/web`
|
| 25 |
-
- [`@lerobot/node`
|
| 26 |
-
- [`lerobot`
|
| 27 |
- **Live Demo**: Try it online at [huggingface.co/spaces/NERDDISCO/LeRobot.js](https://huggingface.co/spaces/NERDDISCO/LeRobot.js)
|
|
|
|
| 13 |
|
| 14 |
# CLI / terminal
|
| 15 |
npm install -g lerobot
|
| 16 |
+
```
|
| 17 |
+
|
| 18 |
+
## CLI Usage
|
| 19 |
+
|
| 20 |
+
```
|
| 21 |
+
npx lerobot@latest --help
|
| 22 |
+
```
|
| 23 |
+
|
| 24 |
+
->
|
| 25 |
+
|
| 26 |
+
```
|
| 27 |
+
Usage: lerobot [options] [command]
|
| 28 |
+
|
| 29 |
+
Control your robot with Node.js (inspired by LeRobot in Python)
|
| 30 |
+
|
| 31 |
+
Options:
|
| 32 |
+
-V, --version output the version number
|
| 33 |
+
-h, --help display help for command
|
| 34 |
+
|
| 35 |
+
Commands:
|
| 36 |
+
find-port Find robot port with interactive cable detection
|
| 37 |
+
calibrate [options] Calibrate robot motors
|
| 38 |
+
teleoperate|teleop [options] Control robot through teleoperation
|
| 39 |
+
release-motors [options] Release robot motors for manual movement
|
| 40 |
+
help [command] display help for command
|
| 41 |
```
|
| 42 |
|
| 43 |
## Resources
|
| 44 |
|
| 45 |
- **LeRobot.js**: [Introduction post on Hugging Face](https://huggingface.co/blog/NERDDISCO/lerobotjs)
|
| 46 |
- **Documentation**:
|
| 47 |
+
- [`@lerobot/web`](./packages/web/README.md) - Browser (WebSerial + WebUSB)
|
| 48 |
+
- [`@lerobot/node`](./packages/node/README.md) - Node.js (Serialport)
|
| 49 |
+
- [`lerobot`](./packages/cli/README.md) - CLI / terminal (using `@lerobot/node`)
|
| 50 |
- **Live Demo**: Try it online at [huggingface.co/spaces/NERDDISCO/LeRobot.js](https://huggingface.co/spaces/NERDDISCO/LeRobot.js)
|