131 lines
4.5 KiB
Markdown
131 lines
4.5 KiB
Markdown
|
# jibo-cli v3.0.7
|
||
|
|
|
||
|
|
The official Jibo command-line interface — originally shipped as part of the Jibo SDK by Jibo, Inc. This tool lets developers initialise skill projects, deploy skills to a physical Jibo robot or the built-in simulator, and manage connected robots from the terminal.
|
||
|
|
|
||
|
|
This is an **archived/preservation release** distributed by the [Jibo Revival Group](https://kevinblog.sytes.net/Code/Jibo-Revival-Group). All required `node_modules` are **bundled inside the package** — no `npm install` step is needed.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
- [Node.js](https://nodejs.org/) v6 or later (v8 LTS recommended for best compatibility)
|
||
|
|
- On Linux/macOS: no additional dependencies
|
||
|
|
- On Windows: Git Bash or WSL recommended
|
||
|
|
|
||
|
|
No internet connection is required to install or run the CLI — everything is self-contained.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
### Option A — Install globally from the directory
|
||
|
|
|
||
|
|
```bash
|
||
|
|
cd jibo-cli-3.0.7
|
||
|
|
npm install -g .
|
||
|
|
```
|
||
|
|
|
||
|
|
Because `node_modules` is already present, npm will use the bundled modules without fetching anything from the registry.
|
||
|
|
|
||
|
|
After installation the `jibo` command will be available system-wide.
|
||
|
|
|
||
|
|
### Option B — Run directly without installing
|
||
|
|
|
||
|
|
```bash
|
||
|
|
node bin/jibo.js <command>
|
||
|
|
```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Commands
|
||
|
|
|
||
|
|
| Command | Description |
|
||
|
|
|---|---|
|
||
|
|
| `jibo init` | Scaffold a new Jibo skill project from a template |
|
||
|
|
| `jibo run` | Deploy and run a skill on the default robot |
|
||
|
|
| `jibo sim` | Launch the Jibo simulator (Electron-based) |
|
||
|
|
| `jibo sync` | Sync skill files to the robot |
|
||
|
|
| `jibo stop` | Stop the currently running skill |
|
||
|
|
| `jibo delete` | Delete a skill from the robot |
|
||
|
|
| `jibo index` | Re-index skills on the robot |
|
||
|
|
| `jibo add-robot` | Register a new robot by IP address |
|
||
|
|
| `jibo remove-robot` | Unregister a robot |
|
||
|
|
| `jibo set-default-robot` | Set the robot used by default |
|
||
|
|
| `jibo robot-list` | List all registered robots |
|
||
|
|
| `jibo update-robot` | Update robot firmware/software |
|
||
|
|
| `jibo reboot` | Reboot the robot |
|
||
|
|
| `jibo poweroff` | Power off the robot |
|
||
|
|
| `jibo diskspace` | Show available disk space on the robot |
|
||
|
|
| `jibo get-volume` | Get the robot's current volume level |
|
||
|
|
| `jibo set-volume` | Set the robot's volume level |
|
||
|
|
| `jibo debug` | Open a remote debug session |
|
||
|
|
| `jibo build-version` | Print SDK/CLI build version info |
|
||
|
|
|
||
|
|
Run `jibo --help` or `jibo <command> --help` for full option details.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Skill Templates
|
||
|
|
|
||
|
|
The `templates/` directory contains two starter templates:
|
||
|
|
|
||
|
|
- **`behavior-template`** — A minimal skill with behaviours (the standard starting point)
|
||
|
|
- **`asset-pack-template`** — A skill that ships custom assets (sounds, animations, etc.)
|
||
|
|
|
||
|
|
`jibo init` will prompt you to choose one and fill in project metadata.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Simulator
|
||
|
|
|
||
|
|
The simulator (`jibo sim`) runs a desktop Electron application that mimics a Jibo robot. It communicates over the same WebSocket protocol as a real robot, so skills can be developed and tested without hardware.
|
||
|
|
|
||
|
|
The simulator source lives in the `simulator/` directory.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Bundled Modules
|
||
|
|
|
||
|
|
All npm dependencies listed in `package.json` are included in the `node_modules/` directory. The package is fully self-contained — no registry access, no `npm install`, no build step required.
|
||
|
|
|
||
|
|
Key bundled packages include:
|
||
|
|
|
||
|
|
| Package | Purpose |
|
||
|
|
|---|---|
|
||
|
|
| `electron-prebuilt` | Powers the Jibo simulator |
|
||
|
|
| `commander` | CLI argument parsing |
|
||
|
|
| `jibo-kb`, `jibo-sync`, `skills-service-manager` | Jibo SDK runtime modules |
|
||
|
|
| `animation-utilities` | Robot animation helpers |
|
||
|
|
| `ws-without-native` | WebSocket communication |
|
||
|
|
| `extract-zip`, `nugget` | Skill packaging and download |
|
||
|
|
| `react` | Simulator UI |
|
||
|
|
| `fs-extra`, `fs-plus`, `wrench` | File system utilities |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Project Structure
|
||
|
|
|
||
|
|
```
|
||
|
|
jibo-cli-3.0.7/
|
||
|
|
├── bin/ # Executable entry points (one per sub-command)
|
||
|
|
├── lib/
|
||
|
|
│ └── jibo-cli.js # Bundled CLI library (browserified)
|
||
|
|
├── simulator/ # Electron-based Jibo simulator application
|
||
|
|
├── templates/ # Skill project scaffolding templates
|
||
|
|
│ ├── behavior-template/
|
||
|
|
│ └── asset-pack-template/
|
||
|
|
├── node_modules/ # All dependencies — pre-bundled, no install needed
|
||
|
|
├── npm-shrinkwrap.json # Locked dependency tree
|
||
|
|
├── package.json
|
||
|
|
└── LICENSE.txt
|
||
|
|
```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Copyright © 2017 Jibo, Inc. All rights reserved.
|
||
|
|
See `LICENSE.txt` for the full Jibo SDK End User License Agreement.
|
||
|
|
|
||
|
|
This preservation release is provided by the Jibo Revival Group for archival and research purposes.
|