Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
168 lines (97 sloc) 3.31 KB

Installation

Buckaroo is available for macOS, Linux and Windows (preview).

macOS

Buckaroo can be installed using Homebrew.

Add Facebook's tap so that Homebrew can find Buck.

brew tap facebook/fb
brew tap loopperfect/lp
brew install loopperfect/lp/buckaroo

The Homebrew formula will install Buck and Java, if required.

Verify your installation with:

buckaroo version

Finally, fetch the cookbook with:

buckaroo update

Linux

Debian and Ubuntu via .deb

We provide a .deb file for Debian and Ubuntu. To install it, download buckaroo.deb and double-click to install.

Alternatively, you can use the command-line:

wget -O buckaroo.deb 'https://github.com/LoopPerfect/buckaroo/releases/download/v1.4.1/buckaroo.deb'
sudo dpkg -i buckaroo.deb

Finally, fetch the cookbook with:

buckaroo update

Linuxbrew

Buckaroo can be installed using Linuxbrew.

Add Facebook's tap so that Linuxbrew can find Buck.

brew tap facebook/fb
brew tap loopperfect/lp
brew install loopperfect/lp/buckaroo

The Linuxbrew formula will install Buck and Java, if required.

Verify your installation with:

buckaroo version

Finally, fetch the cookbook with:

buckaroo update

Windows (preview)

Ensure that you have Buck installed, then clone the Buckaroo source-code from GitHub:

git clone git@github.com:njlr/buckaroo.git
cd buckaroo
git checkout tags/v1.0.0

Build Buckaroo with Buck:

buck build :buckaroo-cli

Buck will output a runnable Jar file in the output folder:

java -jar .\\buck-out\\gen\\buckaroo-cli.jar

Ensure that this command is on your PATH.

Finally, fetch the cookbook with:

buckaroo update

Analytics

By default, Buckaroo will report usage statistics to our servers. These logs allow us to improve Buckaroo by targeting real-world usage. All logs are transferred over HTTPS and are not shared with any third-party.

What is Shared?

The analytics events are as follows:

{
  session, // Random UUID generated on installation
  data: {
    os, // The OS name, e.g. "macOS"
    version, // The version of Buckaroo installed
    command // The command sent to Buckaroo
  }
}

If in doubt, please refer to the source-code of Buckaroo or drop us an email.

Disabling Analytics

If you wish to disable analytics, follow these steps:

  1. Launch Buckaroo at least once:
buckaroo version
  1. Open the buckaroo.json file in your Buckaroo home folder:
open ~/.buckaroo/config.json
  1. Remove the property "analytics". For example:
{
  "cookBooks": [
    {
      "name": "buckaroo-recipes",
      "url": "git@github.com:loopperfect/buckaroo-recipes.git"
    }
  ]
}