Commands

This section provides an overview of the commands available in the develocityctl command line tool. Each command is described along with its subcommands and their functionalities.

To view a list of the commands available in your current Develocity version, run develocityctl with no additional arguments:

develocityctl

Here is a comprehensive overview of all available commands and their subcommands.

backup

Create and restore database backups.

develocityctl backup <subcommand>

Subcommands:

  • create: Create a database backup.

  • copy: Copy a database backup to a local file.

  • restore: Restore the database from a local backup file.

build-scan

Work with Build Scan data.

develocityctl build-scan <subcommand>

Subcommands:

  • copy: Copy Build Scan data between Develocity installations.

config-file

Provides tools for authoring a Develocity configuration file.

develocityctl config-file <subcommand>

Subcommands:

  • hash: Cryptographically hash a secret for storing in a config file.

  • generate-key: Create a key for symmetric encryption of secrets.

  • encrypt: Encrypt a secret value for storing in a config file.

  • encrypt-all: Encrypt all secrets of a config file.

  • decrypt: Decrypt an encrypted value from a config file.

  • decrypt-all: Decrypt all secrets of a config file.

  • validate: Verify that a config file is well-formed.

  • schema: Prints the JSON schema for Develocity configuration files.

database

Execute commands on the Develocity database.

develocityctl database <subcommand>

Subcommands:

  • check-index: Check Develocity database indexes for corruption.

  • query: Execute queries against the Develocity database.

license

Print license file details and convert between license file formats.

develocityctl license <subcommand>

Subcommands:

  • convert: Reads a Develocity license in any format and writes back out it in a specified format.

support-bundle

Create a support bundle for sending to Gradle support.

develocityctl support-bundle

system

System command to interact with Develocity.

develocityctl system <subcommand>

Subcommands:

  • disable-default-identity-provider: Disable the default identity provider.

  • get-default-system-password: Get the default Develocity system password.

  • reset-system-password: Reset Develocity system password.

  • stop: Stop all Develocity components.

  • start: Start Develocity components.

  • restart: Restart Develocity.

  • test-notification: Execute a notification test.

beta

Commands currently in beta stage.

develocityctl beta <subcommand>

Subcommands:

  • system: System command to interact with Develocity.

  • prune-resources: Prunes stale Kubernetes objects from previous releases.

If you have any questions or need any assistance contact the Develocity support team or your customer success representative.