Skip to content

Getting Started

Installation

To access and manage Hub resources, you need to install the Textile CLI. First, download the Textile CLI binary for your platform from the latest releases.

Download

Download the Textile CLI Latest Release.

Install

Open the contents of the downloaded archive and run the install script. This should install the tt tool on your computer. You can verify with hub --help.

Mac Installation

On MacOS you will need to confirm that it is okay to run the tt binary before it will run successfully. You will see this warning:

Select 'Cancel'

Go to 'System Settings' => 'General' where you will be able to click, 'Always Allow'

Run hub --help again and this time select, 'Open` when promted.

You will now be able to continue using the CLI without issue. When you update the binary, you may need to repeat the above steps. We will add developer signing to our MacOS binaries soon.

Account setup

Initialize

To start using remote services such as IPFS pinning, Bucket sharing, and Thread APIs, you need an account on the Hub. Textile provides a simple, password-less account setup. You can create a new account and username with just an email address.

hub init

Whoami

You can always verify that you have an active session on the Hub and that you are using the correct account by running the hub whoami command.

Login

If you've just initialized your account successfully, there is no need to login. However, if you are returning to the Hub and need to re-login, simply use the login command.

hub login

Organizations

The Hub allows you to create organizations easily. Organizations can be one or many collaborators. Members of an Org have management access to the Buckets and App Keys created while in an Org's directory.

Info

You can create, invite, and leave organizations easily. Read more about all Org methods on the CLI docs.

To learn more about sharing Buckets with an organization, read the intro on Organization Buckets.

Enterprise users

If you are interested in enterprise support from Textile, please email us at support@textile.io.