go-textile

README

go-textile

---

Status

This repository contains a the core Textile daemon + command-line client, as well as bindings for mobile (iOS/Android) applications.

See textile-mobile for the Textile Photos iOS/Android app.

What is Textile?

Textile provides encrypted, recoverable, schema-based, and cross-application data storage built on IPFS and libp2p. We like to think of it as a decentralized data wallet with built-in protocols for sharing and recovery, or more simply, an open and programmable iCloud.

Please see the docs for more.

Install

Download the latest release for your OS or jump to Docker. You can also install the Textile desktop tray app, which runs a streamlined version of go-textile via an easy-to-install Electron app!

Usage

Check out the docs site for more detailed usage instructions and tutorials.

~ $ textile --help
Usage:
  textile [OPTIONS] <command>

Help Options:
  -h, --help  Show this help message

Available commands:
  account        Manage a wallet account
  blocks         View thread blocks
  cafes          Manage cafes
  chat           Start a thread chat
  commands       List available commands
  comments       Manage thread comments
  config         Get and set config values
  contacts       Manage contacts
  daemon         Start the daemon
  files          Manage thread files
  init           Init the node repo and exit
  invites        Manage thread invites
  ipfs           Access IPFS commands
  likes          Manage thread likes
  logs           List and control Textile subsystem logs.
  ls             Paginate thread content
  messages       Manage thread messages
  migrate        Migrate the node repo and exit
  notifications  Manage notifications
  ping           Ping another peer
  profile        Manage public profile
  sub            Subscribe to thread updates
  threads        Manage threads
  tokens         Manage Cafe access tokens
  version        Print version and exit
  wallet         Manage or create an account wallet

Contributing

Go >= 1.12 is required.

git clone git@github.com:textileio/go-textile.git

Run the tests

make test

Building

There are various things to build… first off, run setup:

make setup

If you plan on building the bindings for iOS or Android, install and init the gomobile tools:

go get golang.org/x/mobile/cmd/gomobile
gomobile init

CLI/daemon

make build

iOS Framework

make ios

Android Framework

make android

Docs

make docs

Acknowledgments

While now almost entirely different, this project was jump-started from OpenBazaar. Thanks to @cpacia, @drwasho and the rest of the contributors for their work on openbazaar-go. And of course, thank you, Protocal Labs, for the incredible FOSS effort and constant inspiration.

License

MIT