Quickstart

In this guide we’re going to learn how to go from zero to a running Cshell instance with the least amount of effort.

1. Installation

   mac

   You can use Homebrew to install the latest version of Cshell in Mac (both x86 / ARM64)

   brew install txpipe/tap/cshell

   linux

   You can install Cshell on linux system using the following command:

   curl --proto '=https' --tlsv1.2 -LsSf https://github.com/txpipe/cshell/releases/latest/download/cshell-installer.sh

   npm

   You can use Npm to install Cshell on your system:

   npm install @txpipe/cshell

2. Configuration

   Cshell requires a UtxoRPC and TRP provider, the UtxoRPC is to fetch on-chain data, and the TRP is to resolve and submit transactions. You can get one free instance on demeter. So when you have the UtxoRPC and TRP url, run the following command that will guide you through a set of questions to define a provider:

   cshell provider create

   With the provider configured, it is possible to create a wallet or import one. The following example shows how to create one.

   cshell wallet create

3. Running

   Explore the commands in the docs or run cshell --help. The following command opens a GUI explorer using the default provider.

   cshell explorer