Installing TD Toolbelt

You can install the TD Toolbelt to set up your local workstation with td, the Treasure Data command-line (CLI) client.

The TD Toolbelt is distributed in different ways to best suit the target environment:

Use the Ruby option if you are already familiar with Ruby and already have it installed in your system.

Windows 64-bit

This package contains all the necessary dependencies to allow TD Toolbelt to run on a Windows system and therefore includes a version of the Ruby environment which will be installed on the system as part of the process.

  1. Navigate to the TD Toolbelt download page.

  2. Select Windows.

Mac OSX v10.8.5 - Mountain Lion Release or Later

This package contains all the necessary dependencies to allow TD Toolbelt to run on a Mac system and therefore includes a version of the Ruby environment which will be installed on the system as part of the process.

  1. Navigate to the TD Toolbelt download page.

  2. Select OSx.

  3. Select the downloaded package to install it.

If you receive an error "package can't be opened.." when you try to install the package, select control + mouse click (right-click) and select Open to continue the installation.

Ubuntu and Debian

The TD Toolbelt is distributed on Linux as part of the td-agent package.

This package contains all the necessary dependencies to allow the td-agent and td on the CLI to run on a Linux system, including the version of Ruby these tools are guaranteed to work with.


# 20.4 Focal
$ curl -L https://toolbelt.treasuredata.com/sh/install-ubuntu-focal-td-agent4.sh | sh

# 18.04 Bionic
$ curl -L https://toolbelt.treasuredata.com/sh/install-ubuntu-bionic-td-agent4.sh | sh

# Debian Bullseye
$ curl -L https://toolbelt.treasuredata.com//sh/install-debian-bullseye-td-agent4.sh | sh

# 16.04 Xenial
$ curl -L https://toolbelt.treasuredata.com/sh/install-ubuntu-xenial-td-agent4.sh | sh

# Debian Buster
$ curl -L https://toolbelt.treasuredata.com/sh/install-debian-buster-td-agent4.sh | sh


Legacy support for EOL versions is still available

# 14.04 Trusty
$ curl -L https://toolbelt.treasuredata.com/sh/install-ubuntu-trusty-td-agent3.sh | sh
# 12.04 Precise
$ curl -L https://toolbelt.treasuredata.com/sh/install-ubuntu-precise-td-agent3.sh | sh
# Debian Stretch (64-bit only) 
$ curl -L https://toolbelt.treasuredata.com/sh/install-debian-stretch-td-agent3.sh | sh
# Debian Jessie (64-bit only)
$ curl -L https://toolbelt.treasuredata.com/sh/install-debian-jessie-td-agent3.sh | sh


RedHat and CentOS

The TD Toolbelt is distributed on Linux RedHat and CentOS as part of the td-agent package. TD Agent is our streaming log collector.

# Redhat/CentOS 7/8 td-agent4
$ curl -L https://toolbelt.treasuredata.com/sh/install-redhat-td-agent4.sh | sh

This package contains all the necessary dependencies to allow the td-agent and td on the CLI to run on a Linux system, including the version of Ruby these tools are guaranteed to work with.

Legacy support for EOL versions is still available.

# Redhat/CentOS 6 td-agent3
$ curl -L https://toolbelt.treasuredata.com/sh/install-redhat-td-agent3.sh | sh


Amazon Linux

The TD Toolbelt is distributed on Linux as part of the td-agent package. TD Agent is our streaming log collector.

# Amazon Linux 2 td-agent4
$ curl -L https://toolbelt.treasuredata.com/sh/install-amazon2-td-agent4.sh | sh

Legacy support for EOL versions is still available.

# Amazon Linux 1 td-agent3
$ curl -L https://toolbelt.treasuredata.com/sh/install-amazon1-td-agent3.sh | sh

Install Treasure Data's Server-Side Agent

This package contains all the necessary dependencies to allow the td-agent and td on the CLI to run on a Linux system, including the version of Ruby these tools are guaranteed to work with.

Ruby Gem

If you are familiar with Ruby, you can opt to install and maintain the td on the CLI as a gem. To install TD Toolbelt and its dependencies, simply run this command:

$ gem install td

If you are using a Ruby environment manager such as rbevn or rvm, different versions of the TD Toolbelt can be confined within each project, environment or ruby version in use and you might need to install the td gem multiple times. Refer to the Upgrading, Ruby Gem section below for more information.

Confirm Installation

Open your terminal, and make sure you have the td command available.

$ td --version
0.16.X

$ td
usage: td [options] COMMAND [args]
...

Check Installed Versions

TD Toolbelt should be at version 0.16.9.

Mac OSX or Windows

$ td --version

Redhat/CentOS

$ rpm -q td-agent

Ubuntu

$ dpkg - l | grep td-agent