clive

[WORK IN PROGRESS]

Table of contents

1. Introduction
2. Requirements
3. Installation in development mode
4. Running
5. Running via Docker

Introduction

clive is a portmanteau of two words: CLI (command-line-interface) and Hive. Clive is an command line application for interacting with the Hive blockchain. Clive also has a terminal user-interface (TUI) that supports mouse-based navigation that is inspired by midnight commander. Both the CLI and the TUI are written in Python. Clive is being designed in part to replace the original Hive CLI which is primarily used by power users and for writing tests for Hive.

Requirements

• python3.10
• poetry (for development)

Installation in development mode

Since clive is still in development, it's not available on PyPI. To install it in development mode, it's recommended to install it via poetry as it includes dependencies used during development.

1. Install poetry

2. Clone the repository

   git clone https://gitlab.syncad.com/hive/clive.git

3. Create a virtual environment (you can do it your way, using poetry, pyenv, virtualenv, pipx, etc.)

   cd clive/                # Go to repository root directory
   python3.10 -m venv venv/  # Create virtual environment in the venv/ directory
   . venv/bin/activate      # Activate the virtual environment

4. Install CLIVE

   poetry install  # Install CLIVE and its dev-dependencies in the virtual environment

Running

You can simply invoke the TUI application by running the clive command. If you want to use the CLI mode, pass an argument to the clive command.

clive         # Run the TUI application
clive --help  # Run the CLI application

Running via Docker

In order to run clive via Docker, you need to have Docker installed on your machine. You can find the installation instructions here.

You can then run a docker container with your desired version of Clive. Specify the first 8 characters of the commit you want to use, or use the "latest" postfix. The launch command (depending on the branch and chain version you want to use, e.g. TUI latest develop on testnet) will look like:

docker pull registry.gitlab.syncad.com/hive/clive/testnet-instance-develop:testnet-instance-latest && docker run -ti --detach-keys 'ctrl-@,ctrl-q' --registry.gitlab.syncad.com/hive/clive/testnet-instance-develop:testnet-instance-latest

If you want to run clive in the interactive CLI mode, you should include the --cli flag in the command:

docker run -ti registry.gitlab.syncad.com/hive/clive/testnet-instance-develop:testnet-instance-latest --cli