topos-protocol / topos

Implementation of the Topos Protocol

topos is the unified command line interface to the Topos protocol.

Getting Started

Install Rust

The first step is to install Rust along with cargo by following the instructions here.

Install topos

cargo install topos --git https://github.com/topos-protocol/topos

Try out topos!

topos --help

Find more about how topos works in the documentation.

Topos Docker image

The docker images use stable Rust toolchain by default. You can use a different one by defining RUSTUP_TOOLCHAIN argument, the list of available toolchain is here

Build Topos docker image:

DOCKER_BUILDKIT=1 docker build . --build-arg RUSTUP_TOOLCHAIN=[...] -t topos:latest

Run Topos docker image:

docker run -it --rm topos:latest --help

Development

Contributions are very welcomed, the guidelines are outlined in CONTRIBUTING.md.

Support

Feel free to open an issue if you have any feature request or bug report.
If you have any questions, do not hesitate to reach us on Discord!

Resources

• Website: https://toposware.com
• Technical Documentation: https://docs.topos.technology/
• Medium: https://toposware.medium.com
• Whitepaper: Topos: A Secure, Trustless, and Decentralized Interoperability Protocol

License

This project is released under the terms specified in the LICENSE file.