Skip to content

build_and_run_locally.md

Latest commit

 

History

History
52 lines (33 loc) · 1.27 KB

build_and_run_locally.md

File metadata and controls

52 lines (33 loc) · 1.27 KB
Raw

Bothan Installation Guide

Prerequisites

Before building and running Bothan, ensure the following dependencies are installed:

Building Bothan

To install the Bothan CLI, follow the steps below:

  • Clone or navigate to the bothan-api repository.
  • Run the following command to build and install the Bothan CLI binary:
cargo install --path bothan-api/server-cli --bin bothan

This will compile and install the bothan executable

Configuration Setup

Once Bothan is installed, the next step is to initialize the configuration file. By default, the configuration file will be created in the $HOME/.bothan directory.

  • Initialize the configuration file using the command:
bothan config init
  • Open the configuration file in any text editor of your choice and adjust the parameters as necessary

Starting Bothan

After the configuration is set up, you can start Bothan by running:

bothan start

Optional: Specify Config File Path

If the configuration file is not located in the default directory $HOME/.bothan/, use the --config flag to specify the path to the configuration file:

bothan start --config /path/to/config.toml