AirSDK command-line tool commands reference¶

airsdk¶

Usage

airsdk [OPTIONS] COMMAND [ARGS]...

Options

--workspace <workspace>¶: Parrot workspace path that must contain a ‘./build’ buildsystem subdirectory and optionaly an ‘./sdk’ base SDK subdirectory

--sdk <sdk>¶: Overrides the default base SDK path for this variant (ex: ‘./sdk/classic’ from the workspace directory)

--remote-key-provider-url <remote_key_provider_url>¶: Remote key server URL

--yhsm-key-provider-url <yhsm_key_provider_url>¶

--yhsm-session-id <yhsm_session_id>¶

--yhsm-credential-file <yhsm_credential_file>¶

--build-dir <build_dir>¶: Build directory to use instead of the `.airsdk’ mission subdirectory

--out-dir <out_dir>¶: Build directory to use instead of the `.airsdk/out’ mission subdirectory

--version¶: Print airsdk-cli version

--install-completion¶: Install completion for the current shell.

--show-completion¶: Show completion for the current shell, to copy it or customize the installation.

build¶

Build the current mission

Usage

airsdk build [OPTIONS]

Options

--version <version>¶: Use the given version number instead of the one in `mission.yaml’

--sign <sign>¶: Sign using the given key instead of the on in `mission.yaml’

--target <target>¶: Select the specific mission targets to build

--verbose, --no-verbose¶

Enable verbose build

Default:: False

clean¶

Clean the current mission

Usage

airsdk clean [OPTIONS]

Options

--target <target>¶: Select the specific mission targets to build

init¶

Airsdk mission generator

Usage

airsdk init [OPTIONS]

Options

--verbose-help, --no-verbose-help¶

Enable verbose help messages

Default:: True

--recap, --no-recap¶

Enable the project generation recapitulation

Default:: True

-o, --output <output>¶

Set path directory where mission will be create

Default:: PosixPath('.')

install¶

Install the given mission, or the current one if no file is given

Usage

airsdk install [OPTIONS] [MISSION_FILE]

Options

--ip <ip>¶: Use the given ip address as the drone address

--default, --no-default¶

Install the mission as the default mission

Default:: False

--reboot, --no-reboot¶

Reboot the drone after installing the mission

Default:: True

Arguments

MISSION_FILE¶

Optional argument

Mission file to install

keys¶

Usage

airsdk keys [OPTIONS] COMMAND [ARGS]...

Options

--drone-address <drone_address>¶

--persist-drone-secret, --no-persist-drone-secret¶

Default:: False

--auth-token <auth_token>¶

Default:: ''

add¶

Usage

airsdk keys add [OPTIONS] KEY_FILEPATH

Arguments

KEY_FILEPATH¶: Required argument

generate¶

Usage

airsdk keys generate [OPTIONS] PRIVATE_KEY_FILEPATH

Options

--public-key-filepath <public_key_filepath>¶

--overwrite, --no-overwrite¶

Default:: False

Arguments

PRIVATE_KEY_FILEPATH¶: Required argument

list¶

Usage

airsdk keys list [OPTIONS]

remove¶

Usage

airsdk keys remove [OPTIONS] [KEYS]...

Arguments

KEYS¶: Optional argument(s)

list¶

List the missions installed on a drone

Usage

airsdk list [OPTIONS]

Options

--ip <ip>¶: Use the given ip address as the drone address

sign¶

Resign a previously built mission archive. Only work in a mission workspace.

Usage

airsdk sign [OPTIONS] SIGNATURES...

Arguments

SIGNATURES¶

Required argument(s)

Sign using the given key instead of the one in `mission.yaml’(yaml file or string [name]:[type]:[data])

sign-archive¶

Resign a mission archive.

Usage

airsdk sign-archive [OPTIONS] INPUT SIGNATURES...

Arguments

INPUT¶

Required argument

Input mission archive

SIGNATURES¶

Required argument(s)

Sign using the given key (yaml file orstring [name]:[type]:[data])

uninstall¶

Uninstall the given mission, or the current one if no uid is given

Usage

airsdk uninstall [OPTIONS] [MISSION_UID]

Options

--ip <ip>¶: Use the given ip address as the drone address

Arguments

MISSION_UID¶

Optional argument

Mission uid to uninstall