Skip to content

Command Line Modules

deploytool init

Generate a new Deployfile

Options

Unprovided arguments will require user input before the Deployfile.toml is generated.

  • Robot Name

    --name: Name of the robot to be deployed. Must not contain spaces or special characters.

  • SSH Username

    --ssh-user: Set the username for SSH deployment.

  • SSH Host

    --ssh-host: Hostname of IP address for SSH deployment.

  • SSH Port

    --ssh-port: Port for SSH deployment.

  • Target Python Version

    --python-version: Python version of the target. Must be between 3.11 and 4.0.

  • Target glibc Version

    --glibc-version: glibc version of the target.

  • Target Architecture

    --arch: CPU architecture of the target. Can be x64, aarch64, and armhf.

  • Deployfile destination

    --dest-dir: Destination directory for the Deployfile.toml output.

deploytool ssh (Group)

deploytool ssh init

Initialize a new robot SSH private and public key.

Info

SSH keys will be stored globally, and available for all projects. Accidentally committing your SSH keys is not a risk.

Options

Unprovided arguments will require user input before the keys are generated.

  • Robot Name

    --name: Name of the robot to generate keys for. Must not contain spaces or special characters.

deploytool ssh remove [NAME]

Remove an SSH key pain.

Positional Arguments

  • Robot Name

    NAME: Name of the robot to delete keys for. Must not contain spaces or special characters.

deploytool ssh list

List out SSH public and private key paths. Output will be table formatted and colorized.

deploytool ssh apply-key

Apply an SSH public key to a remote robot.

Options

Unprovided arguments will require user input before the Deployfile.toml is generated.

  • Key Name

    --name: Name of the SSH key pair. Must not contain spaces or special characters.

  • SSH Username

    --user: Username to apply the SSH key using.

  • SSH Password

    --password: Password for SSH user.

  • SSH Host

    --host: Hostname of IP address for SSH.

  • SSH Port

    --port: Port for SSH.

deploytool ssh test

Test the SSH connection to a robot.

Options

Unprovided arguments will require user input before the test starts.

  • Key Name

    --key-name: Name of the SSH key pair. Must not contain spaces or special characters.

  • SSH Username

    --user: Username to apply the SSH key using.

  • SSH Host

    --host: Hostname of IP address for SSH.

  • SSH Port

    --port: Port for SSH.

deploytool test

Test Deployfile by connecting to a robot.

Options

  • Deploy Directory

    -d or --directory: Optional. Path to the directory containing the Deployfile.toml. Defaults to the current working directory.

deploytool venv (Group)

deploytool venv create

Create a virtual environment on the remote robot.

Options

An unprovided python location will require user input before the venv is created.

  • Deploy Directory

    -d or --df-directory: Optional. Path to the directory containing the Deployfile.toml. Defaults to the current working directory.

  • Target Python Location

    --python-location: Python binary location on the remote robot. Ex: /usr/bin/python3

deploytool venv delete

Delete a virtual environment on the remote robot.

Options

  • Deploy Directory

    -d or --df-directory: Optional. Path to the directory containing the Deployfile.toml. Defaults to the current working directory.

deploytool robot (Group)

deploytool robot delete

Delete a robot code on the remote robot.

Options

  • Deploy Directory

    -d or --df-directory: Optional. Path to the directory containing the Deployfile.toml. Defaults to the current working directory.

deploytool robot service (Group)

deploytool robot service estop

Send an E-Stop (SIGUSR2) signal to the robot process. This is for debugging purposes only, and should not be used for a real emergency stop.

Options

  • Deploy Directory

    -d or --df-directory: Optional. Path to the directory containing the Deployfile.toml. Defaults to the current working directory.

deploytool robot service stop

Gracefully terminate the robot process.

Options

  • Deploy Directory

    -d or --df-directory: Optional. Path to the directory containing the Deployfile.toml. Defaults to the current working directory.

deploytool robot service start

Start the robot process. This will not restart a running process.

Options

  • Deploy Directory

    -d or --df-directory: Optional. Path to the directory containing the Deployfile.toml. Defaults to the current working directory.

deploytool robot service status

Output the status of the robot process using systemctl.

Options

  • Deploy Directory

    -d or --df-directory: Optional. Path to the directory containing the Deployfile.toml. Defaults to the current working directory.

deploytool robot service install

Install the robot process to auto-start on user login. Login linger can be manually set up to ensure the robot process is started even if the user is not logged in.

Options

  • Deploy Directory

    -d or --df-directory: Optional. Path to the directory containing the Deployfile.toml. Defaults to the current working directory.

deploytool robot service uninstall

Fully uninstall the robot process from auto-starting on user login.

Options

  • Deploy Directory

    -d or --df-directory: Optional. Path to the directory containing the Deployfile.toml. Defaults to the current working directory.

deploytool robot deploy

Deploy code to the remote robot.

Options

  • Deploy Directory

    -d or --directory: Optional. Path to the directory containing the Deployfile.toml. Defaults to the current working directory.

  • Custom Python Wheels

    -W or --custom-wheels: Optional. Custom wheel to install on the remote environment. Multiple -W args can be used at once.

  • No Service Start

    -N or --no-service-start: Optional. Do not start the code after deploying. Existing code will still be stopped.

  • Verbose Logging

    -v or --verbose: Optional. Enables verbose-level logging. Can be chained up to 3 times. Ex: -vvv.

deploytool deploy

Alias to robot deploy