Skip to main content

Command Reference

This page summarizes the commands airborne-devkit provides. There are two groups: the devkit-specific commands (login plus the five special workflow commands), and the re-exposed Core CLI operations for working with organisations, applications, dimensions, files, packages, and releases.

All commands accept -h, --help for inline usage, and -V, --version is available on the CLI itself.

Devkit-specific commands​

CommandDescription
loginAuthenticate with client credentials and store a token locally. See Authentication.
create-local-airborne-configScaffold airborne-config.json for your project. See Local configuration.
create-local-release-configBundle your JS and write a per-platform release_config.json. See Local configuration.
update-local-release-configRe-bundle and update an existing release_config.json. See Local configuration.
create-remote-filesUpload or register the bundled files with Airborne. See Remote files and packages.
create-remote-packageAssemble registered files into a deployable package. See Remote files and packages.

Core CLI operations under airborne-devkit​

Every low-level Airborne API operation is also available through airborne-devkit, invoked as:

npx airborne-devkit <Command> [options]

These commands behave exactly like their Core CLI counterparts, with one convenience: airborne-devkit injects your stored authentication token automatically, so you never pass --token.

The available operations are:

  • Organisation — CreateOrganisation, ListOrganisations, RequestOrganisation
  • Application — CreateApplication, GetUser
  • Dimension — CreateDimension, UpdateDimension, DeleteDimension, ListDimensions
  • File — CreateFile, UploadFile, ListFiles, ListFileGroups
  • Package — CreatePackage, ListPackages
  • Release — CreateRelease, GetRelease, ListReleases, ServeRelease, ServeReleaseV2

For the full parameter tables and examples for each of these, see the Core CLI command reference. (When using them through airborne-devkit, omit the --token parameter shown there.)

Input methods​

Every command — both devkit-specific and re-exposed — supports three ways of supplying parameters.

Method 1 — Individual flags​

npx airborne-devkit CreateApplication \
  --application myapp \
  --organisation myorg

Method 2 — JSON parameters file​

Pass a .json file prefixed with @:

npx airborne-devkit CreateApplication @params.json

Where params.json contains:

{
  "application": "myapp",
  "organisation": "myorg"
}

Method 3 — Mixed (JSON file + flag overrides)​

Combine a parameters file with individual flags. Flag values override matching keys in the JSON file:

npx airborne-devkit CreateApplication @params.json --application override-value
note

The parameters file must have a .json extension and be referenced with a leading @ (for example @params.json). Any value you pass as a flag takes precedence over the same key in the file.

See also​