Skip to main content
Version: Next (Private Preview)

nexoctl CLI

nexoctl is the Nexo command-line interface for administrators, support engineers, and plugin developers. The current binary reports version 0.2.0.

Command support

AreaImplemented commandsCurrent support
AuthenticationloginUnavailable end to end: interactive token response fields do not match the current Control Plane; API-key mode exposes the key through process arguments.
Project statusstatusCommand exists, but there is no currently supported CLI authentication path; detailed Manager-version and replica fields also do not match the API response.
UpgradesupgradeCommand exists, but its request/response contract does not match the current Control Plane. Use the console/support workflow instead.
Diagnosticsdiagnostics, diagSupported with Kubernetes access; pass the installation namespace explicitly.
Support archivessupport-bundle and aliasesSupported for collection. Redaction is best-effort and requires a separate content review before transfer.
Plugin developmentscaffold, validate, test, publishScaffold/validate/test and dry-run packaging are available. Live publish is not recommended until credential input and archive allowlisting are hardened.
CLI informationversion, helpSupported.

See the complete command reference and safe how-tos.

Responsibilities

  • collect Kubernetes diagnostics and support material;
  • scaffold, validate, and test pipeline plugins;
  • expose CLI version and command help.

Control Plane login, status, and upgrade commands remain visible in 0.2.0 but are not end-to-end supported against the current Control Plane contract.

Changes and known limitations

0.2.0

  • Added login and project-status command implementations; current API contracts are incompatible, so they are not supported workflows.
  • Added upgrade command scaffolding; the current API contract is incompatible, so it is not an operational upgrade path.
  • Added diagnostics collection.
  • Added support-bundle generation, inspection, and redaction.
  • Retained plugin scaffold, validation, local harness, packaging, and publication commands.

Not currently implemented

  • project switch or active-project management;
  • a general Nexo installation command;
  • license administration;
  • safe stdin/credential-helper input for API keys;
  • publish archive allowlisting or ignore-file support.

Data handling

  • Saved CLI configuration uses owner-only file permissions.
  • API keys supplied through --api-key can be captured from process arguments.
  • Support-bundle redaction recognizes common patterns but cannot guarantee removal of every secret.
  • Plugin packaging includes every non-hidden-directory file under the selected directory, including hidden files. Use a clean staging directory and inspect the archive.

Search Nexo documentation

Type to search titles, headings, and page content.