Installation and Account Setup¶
To create an account, you need first to install the Hub CLI. The CLI is where you are going to do all account management, create orgs, create API keys, etc. The first step is to download and install the application.
Install the Command-line Interface¶
Download the Hub CLI binary from the release landing page: https://github.com/textileio/textile/releases/latest.
You'll see two binaries available for download on the Textile releases page,
buck. Ignore the
buck binary for now.
buck is used to interact with buckets in a stand-alone manner, independent of Textile Hub.
hub provides all the functionality you'll need to interact with the Textile Hub and Buckets together.
On MacOS you will need to confirm that it is okay to run the
hub binary before it runs successfully. You will see this warning:
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.
The next step is to initialize an account. The Hub CLI use magic-link signin, so it only requires you to enter and verify a valid email.
You have now created an account on the Textile Hub! You can now run all the available commands, such as
hub keys ls,
hub logout, and
Now that your account exists, the next time you use the CLI on a new computer, or after logging out, you simply need to
Orgs allow multiple developers to work together using shared resources. Members of an organization can collaboratively manage, create, or remove API keys, and more.
You can create an
hub org create
Next, you can begin inviting collaborators by email addresses.
hub org invite
You can now share and collaborate with all
org members. For example, when creating new buckets, you can create them in the
org and immediately be available to your collaborators. Additionally, you can create and share API key admin.
Org bucket init
HUB_ORG=<org name> hub buck init
Org keys create
HUB_ORG=<org name> hub keys create
To learn more about sharing Buckets with an organization, read the intro on Organization Buckets.
If you are interested in enterprise support from Textile, please email us at email@example.com.
If you delete your account or organization, data replicated on IPFS through any API will also be removed. So if you remove your account, we highly encourage you to replicate the data on an external IPFS node, provide tools for your users to export or replicate their account data, or host external Thread Services to migrate your user Thread replication to.