Navigation

• Home
• Getting started
• Task Arguments and Variables
• Enable remote command execution
• Configuration reference
  • Project
  • Target
  • Task
  • Host
  • Group
  • Firewall Rule
  • Module
• Modules - reusable Task lists
• Command Reference
• Command Plugins
• Hacking

Command Reference

Below you'll find a list of all the available commands in the standard distribution of Droid.

Click on the command-name for full description, available arguments and options, etc.

• schema:load Load database schema into database
• os:reboot Initiate a reboot.
• hipchat:room-message Sends a HipChat message to a room
• apache:dismod Disable Apache modules.
• apache:enmod Enable Apache modules.
• apache:ensite Enable Apache sites.
• apache:dissite Disable Apache sites.
• git:merge Merge branch
• git:fetch Fetch commits from remote
• git:pull Pull (Fetch+Merge) commits from remote
• service:restart Restart a service
• service:reload Reload a service
• service:start Start a service
• service:stop Stop a service
• apt-get:upgrade Upgrade all packages to latest versions from sources
• apt-get:clean Clears out the local repository of retrieved package files.
• apt-get:remove Removes package(s) through apt-get on Debian based systems
• apt-get:update Update the package index from sources
• apt-get:install Installs package(s) through apt-get on Debian based systems
• fs:setline Add a (name, value) pair to a line based file, or update an existing (name, value) pair.
• fs:copy Copy a single file
• fs:mkdir Creates a directory
• fs:template Generates a file from a template
• fs:touch Change file access and modification time
• fs:chmod Modifies the file mode bits
• fs:mount Mount a filesystem by updating /etc/fstab
• fs:rename Renames a file/directory
• fs:symlink Make a symbolic link
• fs:chown Change ownership of a file
• cron:addjob Create a cron job.
• cron:deljob Delete a cron job.
• debconfdb:set Set debconf database entries from the supplied file.
• composer:install Composer install
• brew:unlink Unlink homebrew package
• brew:uninstall Uninstall/remove homebrew package
• brew:tap Adds a homebrew tap
• brew:untap Removes a homebrew tap
• cask:install Install homebrew cask package
• cask:uninstall Uninstall homebrew cask package
• brew:install Install homebrew package
• mysql:dump-all Perform a mysql dump for all databases on a server
• mysql:master-info Configure a MySQL replication slave with information about the master.
• mysql:dump Perform a mysql dump
• mysql:adduser Add a MySQL user account.
• mysql:load Load a mysql dump
• mysql:deluser Delete a MySQL user account.
• ping Ping the specified hosts, or all hosts in the Inventory.
• target:run Run a target
• inventory Show inventory configuration
• config Show project configuration
• module:install Install third-party droid modules in droid-vendor
• generate:plugin Generate a plugin project
• debug:echo Echo a message to the console
• ssh:exec Execute a command over ssh
• ssh:copy Copy files to or from a remote host
• bower:install Bower install
• shell:exec Execute the given command line in Bash.
• nginx:dissite Disable Nginx sites.
• nginx:ensite Enable Nginx sites.
• user:enable-key-auth Append ssh public keys to a user authorized_keys file.
• user:create Add a Unix user account.
• fw:install Generate and install UFW firewall rules on an Inventory host or all Inventory hosts.
• fw:generate Generate and print UFW firewall rules for an Inventory host or all Inventory hosts.
• fixtures:load Load Alice fixture data into database