ResDB-CLI

resdb-cli is a command-line interface for managing ResDB instances and Python SDK instances. It provides functionalities to create, delete, view, and manage instances in a simple and efficient way.

Table of Contents

• Installation
• Configuration
• Usage
• Commands

Installation

To use resdb-cli, you can download the binary from the Releases page on GitHub.

1. Go to the Releases page.

2. Download the latest release for your operating system (e.g., resdb-cli-linux for Linux).

3. Make the downloaded binary executable:

   chmod +x resdb-cli
   

Configuration

resdb-cli uses a configuration file (config.ini) to store settings such as the MongoDB URI. Follow the steps below to configure the CLI:

Create a configuration file named config.ini, Replace the MongoDB_URI value with the appropriate MongoDB connection string.:

 [Database]
 MongoDB_URI = mongodb://localhost:27017/
 name = resui

 [User]
 current_user = gn@gmail.com

Usage

Once installed and configured, you can use resdb-cli to perform various actions related to ResDB and Python SDK instances. Run the CLI with the following command:

    ./resdb-cli

Commands

• Login: Logs in to the specified user account.

    ./resdb-cli login # Enter email and password when prompted

• Logout: Logs out from the current user account.

    ./resdb-cli logout

• Create Instance: Creates a new ResDB or Python SDK instance.

    ./resdb-cli create_instance <type>

• View Instances: Displays details about running instances.

    ./resdb-cli view_instances

• Delete Instance: Deletes a running ResDB or Python SDK instance.

    ./resdb-cli delete_instance <instance_id>

• Current User: Displays the currently logged-in user.

    ./resdb-cli whoami

For more detailed information about each command, run ./resdb-cli --help or ./resdb-cli --help.