CLI

During the installation of Buddy On-premises, a Command Line Tool for managing your installation will be installed as well. In this article we describe how to use it.

All the commands need to be executed by root users (on Ubuntu they should be executed together with thesudocommand).

Here's a list of commands you can use:

  1. buddy logs – shows the logs from the application
  2. buddy clear-cache – clears the Docker cache (docker prune) as well as the filesystems and DinD (disk contents).
  3. buddy [--yes] restore– restores the backup The --yes flag restores the last backup it finds
  4. buddy [--yes] [--full] backup – makes the data backup The --yes flag makes it automatically, without user interaction (automatically deletes old backups) The --full flag enables full cache backup (by default we make backup without filesystems and Docker cache)
  5. buddy start – starts the application
  6. buddy restart – restarts the application
  7. buddy stop – stops the application
  8. buddy configure – lets you configure the application. You will see a numerical menu:
    • 0 – Exit configuration
    • 1 – Custom domain
    • 2 – Custom domain SSL certificate
    • 3 – Application data path (you can move the data to another partition or disk)
    • 4 – IP & ports. You can set:
      • external IP – what is opened in the browser
      • server IP – the IP to which the application on the server will be bound (by default all the interfaces on the server)
      • HTTPS port (443 is set by default)
      • HTTP port (80 is set by default)
      • Git SSH port (22 is set by default)
    • 5 – Reset workspace owner password (shows the e-mail and the token to log in)
    • 6 – Build CPU limit
    • 7 – Build memory limit
    • 8 – Concurrent executions limit
    • 9 – Parallel actions limit
    • 10 – Amazon SNS (SMS service)
    • 11 – Repo max file size
    • 12 – HAProxy ciphers
    • 13 – Application memory management
  9. buddy [--yes] uninstall – lets you delete the standalone (CLI has to be deleted manually) The --yes flag enables doing it without user interaction
  10. buddy [--yes] update – lets you download a new version of the application The --yes flag enables doing it without user interaction
  11. buddy status – shows the status of the application and all its components (Docker images)

Always available commands:

buddy feedback – lets you send feedback to our team

buddy version – shows the CLI and the standalone version (if it is installed)

buddy terms – shows the terms