teller

README

Teller

Teller is a sophisticated Command Line Interface (CLI) tool designed to facilitate developers' interactions with STX contracts. It streamlines the process of exploring source code and leveraging various analytics tools, thereby significantly enhancing the developer experience within the STX ecosystem. With its intuitive design, Teller ensures that integrating STX contracts into projects is both straightforward and efficient.

Installing

Homebrew is the recommended way to install Teller:

brew install hashhavoc/tap/teller

Configuration

There is a configuration file that contains various configuration values. You can find an example at config/config.yaml.example.

teller init

This will create a new configuration file at ~/.teller.yaml with the default values. You can then edit this file to your liking. There is not currently a way to specify the configuration file location. Not all of the endpoints are avaliable publicly, so you may need to specify your own endpoints.

Source

Building

To use Teller, follow these simple steps:

1. Clone the repository:

   git clone https://github.com/hashhavoc/teller.git
   

2. Navigate to the project directory:

   cd teller
   

3. Build the executable:

   go build -o teller cmd/teller/main.go
   

4. Run Teller:

   ./teller
   

Command Line Interface

Upon running Teller, you'll encounter the following command line interface:

➜  teller
NAME:
   teller - interact with the stx blockchain

USAGE:
   teller [global options] command [command options]

VERSION:
   v0.0.1

COMMANDS:
   init           Creates a new configuration file
   contracts      Provides interactions with contracts
   token          Provides interactions with tokens
   wallet         Provides interactions with wallets
   dex            Provides interactions with multiple dex
   transactions   Provides interactions with transactions
   ordinals, ord  Provides interactions with ordinals
   help, h        Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

Commands

Teller offers the following commands:

• contracts: Provides interactions with contracts.
• token: Provides interactions with tokens.
• wallet: Provides interactions with wallets.
• dex: Provides interactions with multiple decentralized exchanges.
• transactions: Provides interactions with transactions.
• ordinals: Provides interactions with ordinals on bitcoin.
• help: Shows a list of commands or help for one command.

Support

If you encounter any issues or have suggestions for improvement, please feel free to open an issue on GitHub. Your feedback is highly appreciated!

License

This project is licensed under the GNU General Public License v3.0 License - see the LICENSE file for details.