AirSDK command-line tool commands reference#
airsdk#
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-password <yhsm_password>#
- --version#
Print airsdk-cli version
- --install-completion <install_completion>#
Install completion for the specified shell.
- Options:
bash | zsh | fish | powershell | pwsh
- --show-completion <show_completion>#
Show completion for the specified shell, to copy it or customize the installation.
- Options:
bash | zsh | fish | powershell | pwsh
build#
Build the current mission
airsdk build [OPTIONS]
Options
- --simulator, --no-simulator#
Build for simulator instead of a physical drone
- Default:
False
- --verbose, --no-verbose#
Enable verbose build
- Default:
False
clean#
Clean the current mission
airsdk clean [OPTIONS]
init#
Airsdk mission generator
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:
.
install#
Install the given mission, or the current one if no file is given
airsdk install [OPTIONS] [MISSION_FILE]
Options
- --simulator, --no-simulator#
Install on a simulator instead of a physical drone
- Default:
False
- --ip <ip>#
Use the given ip address as the drone address
- Default:
anafi-ai.local
- --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
keys#
airsdk keys [OPTIONS] COMMAND [ARGS]...
Options
- --drone-address <drone_address>#
- Default:
anafi-ai.local
- --drone-port <drone_port>#
- Default:
80
- --persist-drone-secret, --no-persist-drone-secret#
- Default:
False
- --auth-token <auth_token>#
- Default:
add#
airsdk keys add [OPTIONS] KEY_FILEPATH
Arguments
- KEY_FILEPATH#
Required argument
generate#
airsdk keys generate [OPTIONS] PRIVATE_KEY_FILEPATH PUBLIC_KEY_FILEPATH
Options
- --overwrite, --no-overwrite#
- Default:
False
Arguments
- PRIVATE_KEY_FILEPATH#
Required argument
- PUBLIC_KEY_FILEPATH#
Required argument
list#
airsdk keys list [OPTIONS]
remove#
airsdk keys remove [OPTIONS] [KEYS]...
Arguments
- KEYS#
Optional argument(s)
list#
List the missions installed on a drone
airsdk list [OPTIONS]
Options
- --ip <ip>#
Use the given ip address as the drone address
- Default:
anafi-ai.local
sign#
Resign a previously built mission archive
airsdk sign [OPTIONS] [SIGNATURES]...
Options
- --input <input>#
Input mission archive instead of the default built archive in the .airsdk folder
- --output-dir <output_dir>#
Output mission directory instead of the default one in the .airsdk folder
- --simulator, --no-simulator#
Build for simulator instead of a physical drone
- Default:
False
- --verbose, --no-verbose#
Enable verbose build
- Default:
False
Arguments
- SIGNATURES#
Optional argument(s)
uninstall#
Uninstall the given mission, or the current one if no uid is given
airsdk uninstall [OPTIONS] [MISSION_UID]
Options
- --ip <ip>#
Use the given ip address as the drone address
- Default:
anafi-ai.local
Arguments
- MISSION_UID#
Optional argument