TigerBeagle

TigerBeagle is a CLI tool designed to simplify account and transaction data management for TigerBeetle, the high-performance distributed database engine.

TigerBeagle is a CLI tool for TigerBeetle ledger data management

Usage:
  tigerbeagle [command]

Available Commands:
  bulk-transfer     Perform multiple transfers in bulk
  completion        Generate the autocompletion script for the specified shell
  create-account    Create a new account
  doctor            Validate the connectivity to TigerBeetle
  generate          Generate sample JSON files for accounts or transfers
  get-account       Get account details
  help              Help about any command
  migrate-accounts  Migrate accounts from a JSON file
  migrate-transfers Migrate transfers from a JSON file
  transfer          Transfer funds between accounts

Flags:
      --code uint16         Account/Transfer code (default 10)
      --flags uint16        Account/Transfer flags
  -h, --help                help for tigerbeagle
      --ledger uint32       Ledger ID (default 700)
      --tb-address string   TigerBeetle address (default "3000")

Use "tigerbeagle [command] --help" for more information about a command.

Project Goals:

• Be a tool to help bridge between TigerBeetle and systems of transactional reference (i.e., transactional metadata)
• Faciliate mass account / transaction manipulation for conversion, migration and testing
• Generate test data for ledger testing and preparation

Table of Contents

• TigerBeagle
  • Table of Contents
  • Features
  • Installation
  • Usage
  • Commands
  • Migration Guide
  • Contributing
  • License
  • Acknowledgments

Features

• Create and manage accounts in TigerBeetle
• Perform single and bulk transfers
• Migrate accounts and transactions from JSON files
• Validate connectivity to TigerBeetle
• Simplify testing and development workflows

Installation

To install TigerBeagle, you need to have Go 1.16 or later installed on your system. Then, you can install it using the following command:

go install github.com/kris-hansen/tigerbeagle@latest

Alternatively, you can clone the repository and build it manually:

git clone https://github.com/kris-hansen/tigerbeagle.git
cd tigerbeagle
go build

Usage

Before using TigerBeagle, make sure you have a TigerBeetle server running. You can set the TigerBeetle address using the TB_ADDRESS environment variable or the --tb-address flag.

export TB_ADDRESS=3000
tigerbeagle [command]

or

tigerbeagle --tb-address=3000 [command]

Commands

• create-account: Create a new account
• get-account: Get account details
• transfer: Perform a transfer between accounts
• bulk-transfer: Perform multiple transfers in bulk
• migrate-accounts: Migrate accounts from a JSON file
• migrate-transfers: Migrate transfers from a JSON file
• doctor: Validate connectivity to TigerBeetle

For detailed information on each command, use the --help flag:

tigerbeagle [command] --help

Migration Guide

For detailed instructions on migrating accounts and transfers, please refer to our Migration Guide.

Contributing

We welcome contributions to TigerBeagle! Please feel free to submit issues, fork the repository and send pull requests!

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a pull request

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

Acknowledgments

• TigerBeetle - The high-performance accounting database that inspired this project
• All the contributors who have helped shape TigerBeagle

---

For more information, bug reports, or feature requests, please open an issue on GitHub.