Command line
These are the plem commands you use in a terminal without opening the TUI. The list of commands is in Commands. This page covers what each one does.
plem is installed by the plem-cli package. plem <command> runs the plem-<command> executable installed on this device and passes the arguments through unchanged. The commands you have therefore depend on the installed packages. A device with only the drive package (plem-drive), for example, has only plem drive.
plem --helplists the commands installed on this device.plem <command> --helpshows that command's own help.plemwith no arguments starts the TUI when it is installed and lists the commands when it is not.- A command that is not installed prints
plem <command>: not installed on this device (no plem-<command>)and exits with code 127.
plem code handles robot stack start and stop, motion, the gripper and saved poses through conversation. It asks for confirmation before any physical motion and before changing saved poses or profiles.
While a Job is running or paused on the Teaching Pendant, plem code refuses arm motion and gripper commands and tells you which Job it is. End the Job with ⏹ on the Pendant, then ask again. The check runs once, right before the command is sent. It cannot stop a Job you start on the Pendant after that.
Prompts when you run plem
Update notice
When a newer version exists, a notice appears before the TUI starts.
PLEM 0.10.0 → 0.10.1 available (patch)
Update now? [Y/n] (the robot starts if there is no answer in 20 s)
Enterorystarts the update.nskips it.- If you press nothing for 20 seconds, or press
Ctrl+C, the prompt is skipped and the TUI starts. This keeps the prompt from blocking an unattended restart. - The prompt appears only when you run
plemdirectly in a terminal. If the version check fails, it is skipped.
The full procedure is in Update.
Workspace adoption
When you run plem inside a built user workspace, it asks Use this directory as the active workspace? [y/. The default is no. An adopted workspace is applied as an overlay to every robot launch and is also where custom torque controllers are found (Custom torque controller). If that is not what you want, answer no.
plem kill
Use it when the TUI exited abnormally and stack processes were left behind. It sends a stop signal to all of them at once, then force-kills whatever is still running 3 seconds later.
These are not touched. Stop each one in the terminal that started it.
- A drive bus started with
plem drive run: stop it with Ctrl-C. - A
ros2 bag recordrecording. - A ROS launch you started from a shell (a MoveIt demo, for example), even from the same terminal. It is stopped anyway if its launch file has the same name as a PLEM one (
robot.and others), if it was started through alaunch. py bash -cwrapper, or if it was started in one command (a pipeline or script) together with the PLEM stack.
plem kill --dry # only list what would be stopped
plem kill # clean up
plem kill --force # force-kill at once without waiting (wins over --dry)
plem kill does not engage the brakes first and does not wait for the cameras to shut down. If the TUI is running, stop with s and quit with q (Stops and recovery). Other cautions are in Launching the robot stack.
plem remote
Run it when the support team asks you to. It opens a remote-support tunnel and holds the terminal. Ctrl+C closes it.
plem workspace
Shows the registered workspace. A workspace is an overlay applied to every robot launch. Its main use is custom torque controllers.
plem workspace clear only removes the registration. A Plugin controller chosen in a robot profile stays. To go back to a built-in controller, change the profile's torque controller too.
plem profile
Shows and changes the gripper and F/T sensor in a robot profile from the terminal. The same choices are in the robot edit screen and in the Pendant's robot settings.
| Subcommand | What it does |
|---|---|
plem profile grippers | Gripper models usable on this device (driver installed) |
plem profile set-gripper <robot> <model> | Changes that robot's gripper. none removes it |
plem profile ft-sensors | F/T sensor models usable on this device (description package installed) |
plem profile set-ft-sensor <robot> <model> | Changes that robot's F/T sensor. none removes it |
Both set- commands:
- apply the saved value from the next launch.
- show the change without saving it when given
--dry-run. - ask you to try again shortly if something else (the settings screen or the Pendant) is saving the same robot.
Which models each robot accepts is in Supported hardware. An F/T sensor the robot does not support is refused with cannot be set on this robot. On a robot with a camera calibration, changing either one leaves a one-line warning (The tool stack changed (…), see Hand-eye calibration) and still saves. When you ask plem code to change the gripper, it uses this command and asks you to confirm. plem code does not change the F/T sensor.
plem uninstall
Removes PLEM from the device. It asks for the sudo password, shows what it will remove, and asks for confirmation before it proceeds. If you only want fresh packages, use plem update instead of removing.
plem uninstall --keep-license # remove, but keep the license and device key
plem uninstall --help # all options
By default it also deletes the license and the plem code device key. The device registration stays on the PLEM server, so registering the same device again is refused with any token. The PLEM server does not hand out the device key again either, so the file you keep is the only copy.
If you plan to reinstall after removing:
- If you must remove PLEM, add
--keep-licenseto keep the license and device key files. Contact the support team before you reinstall. - If you already removed it with the defaults, ask your contact to delete the existing device registration. The token used for that registration is revoked with it. Then install with a newly issued token.
Choosing what else to remove
Shared components and user data are kept unless you add an option. You can combine options.
| Option | What it does |
|---|---|
--keep-license | Keeps the license, registration data and plem code device key (/etc/) |
--remove-user-data | Also deletes user data such as robot profiles and logs (~/.) and the local full-screen browser profiles (~/., ~/.). Kept by default |
--remove-ros2-source | Also removes the ROS 2 apt repository entry. Kept by default (shared with other ROS work) |
--remove-pip-deps | Also removes the Python packages the PLEM install put in system pip. Kept by default. Other programs using the same packages (cuMotion included) break with them |
--remove-pendant-browser | Also removes the Firefox installed for the full-screen Pendant and its apt entry. Kept by default |
--remove-cumotion | Also removes the collision avoidance components (cuMotion, nvblox) and their apt channel. The pip stack such as torch and other Isaac ROS packages stay |
--keep-virtual-display | Keeps the virtual display setup PLEM configured. By default it is restored |
--all | Turns on every --remove-* above and also removes the plugin build tools (colcon and others). Items you name with --keep-license and the like are kept |
--non-interactive | Runs at once without asking for confirmation |
plem init
Creates a custom torque controller scaffold. The full flow is in Custom torque controller.