Skip to content

cli.md

Latest commit

 

History

History
43 lines (32 loc) · 1.52 KB

cli.md

File metadata and controls

43 lines (32 loc) · 1.52 KB

orb-hil cli

There is a CLI tool to facilitate hardware-in-loop operations. This tool lives in the orb-software repo and releases can be downloaded here.

It is a single, statically linked CLI tool with lots of features helpful for development:

  • Rebooting orbs into either normal or recovery mode
  • Flashing orbs (including downloading from S3, extraction, etc)
  • Executing commands over serial
  • Automating the login process over serial

Required peripherals

Different orb-hil subcommands require different hardware peripherals. We strongly recommend at least getting an x86 linux machine and a serial adapter. See the hardware setup page for more detailed info.

Here are the different hardware peripherals necessary for the different subcommands of orb-hil:

  • orb-hil flash: x86 linux machine
  • orb-hil reboot: Serial adapter.
  • orb-hil login: Serial adapter.
  • orb-hil cmd: Serial adapter.

Logging in to AWS

The flash subcommand can download S3 urls. To set this up, we recommend following the instructions to set up aws. Then you can run

AWS_PROFILE=hil aws sso login # refresh your credentials for the hil profile
AWS_PROFILE=hil cargo run -p orb-hil # tell the orb-hil cli to use the hil profile