Buddy CLI

When you install Buddy On-premises, a Command Line Tool (CLI) is installed. Use it to manage and configure your installation.

This document describes the CLI commands and the available configuartion options.

All commands must be executed by root users. Run them with sudo on Ubuntu or macOS.

Basic commands

  • buddy start – starts the application
  • buddy stop – stops the application
  • buddy restart – restarts the application
  • buddy feedback – allows to send feedback to Buddy customer support
  • buddy version – shows the CLI and Buddy On-Premises version
  • buddy terms – shows the Buddy On-Premises Software License Agreement

Advanced commands

  • buddy configure – allows to configure the application.
  • buddy [--yes] [--full] backup – creates a backup of the app. Use the --yes flag to create a backup without the need for user interaction and delete old backups. Use the --full flag to include cache in the backup.
  • buddy [--yes] restore – restore application from a backup. Use the --yes flag to use the latest backup available to the system.

Click here to learn more about backing up and restoring Buddy On-Premises.

  • buddy clear-cache – clears the Docker cache (docker prune), filesystems, and DinD disk contents.
  • buddy status – shows the status of the application and its components.
  • buddy diagnose – runs diagnostics on your installation. Shows tips for fixing problems it finds.
  • buddy [--yes] update – shows if a new version of the app or the CLI is available and provides installation insctructions. Use the --yes flag to automatically download and apply available updates.
  • buddy [--yes] uninstall – uninstalls Buddy On-Premises. You must remove the CLI manually. Use the --yes flag to do it without requiring user interaction.
  • buddy set – allows to configure integrations through the CLI. Run the command to get the full list of things you can configure. Run buddy set {INTEGRATION_NAME} to learn more about configuring the selected integration.
  • buddy fix-mysql – fixes MySQL issues. Run only when buddy diagnose tells you to do so.
  • buddy install-worker – allows you to install a new worker for your instance through a CLI wizard.

Click here to learn more about workers in Buddy On-Premises.

CLI cofiguration options

When you run buddy configure, the CLI shows the options listed below. To configure an option, type the corresponding number and press Enter.

  1. Exit configuration
  2. Custom domain – allows to set a custom domain used to access Buddy On-Premises through the browser.
  3. Custom domain SSL certificate – allows to set a valid SSL certificate for the custom domain.
  4. Application data path – allows to move application data to a different partition or disk.
  5. IP & ports – allows to set:

    • external IP – used to access the instance through the browser
    • server IP – IP to which the application is bound; by default all application interfaces are bound to this address
    • HTTPS port (default 443)
    • HTTP port (default 80)
    • Git SSH port (default 22)
  6. Reset Workspace owner password – resets the password and provides the email address and a one-time token to sign in after the reset.
  7. Build CPU limit – allows to limit CPU usage by pipelines.
  8. Build memory limit – allows to limit memory usage by pipelines.
  9. Concurrent executions limit – allows to limit the number of pipelines running at the same time.
  10. Parallel actions limit – allows to limit the number of actions that run at the same time in a single pipeline.
  11. SMS service – allows to configure SMS messages sent by Amazon AWS as notifications.
  12. Repo max file size – allows to set the maximum size of files you can push to a repository when using Buddy Git Hosting.
  13. HAProxy ciphers – allows to change HAProxy ciphers to customize security policies for connected clients.
  14. Application memory management – allows to adjust the amount of memory used by each of the application's components.
  15. API requests limit – allows to adjust rate limits for accessing resources. By default, users can make 1000 requests to a resource every 15 minutes.

Click here to learn more about rate limiting in Buddy.

  1. Telemetry – allows to enable or disable telemetry.
  2. Pipelines worker assignment – allows to choose if pipelines are automatically re-assigned to a different worker if the worker vCPU load exceeds 100%.