Google Git
Sign in
apache / incubator-resilientdb-ResCLI / 4ffeab7a2968c0128676aadf37fc8b1b494f3ed7
commit4ffeab7a2968c0128676aadf37fc8b1b494f3ed7[log] [tgz]
authorGopal Nambiar <gopalnambiar2@gmail.com>Wed Feb 28 14:50:42 2024 -0800
committerGopal Nambiar <gopalnambiar2@gmail.com>Wed Feb 28 14:50:42 2024 -0800
tree15ca98c78fa1d7c35d91187b82a6b235e4cddf93
parentf7abb2dc7673573954b9601367e68706bbec2bf0 [diff]
Python -> Ruby
10 files changed
tree: 15ca98c78fa1d7c35d91187b82a6b235e4cddf93
  1. .github/
  2. bin/
  3. lib/
  4. config.ini
  5. Gemfile
  6. LICENSE
  7. Rakefile
  8. README.md
  9. res_cli.gemspec
  10. res_cli.py
README.md

GitHub

ResCLI

ResCLI 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

To use ResCLI, 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., res-cli-linux for Linux).

  3. Make the downloaded binary executable:

    chmod +x res-cli

Configuration

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

Create a configuration file named config.ini, Replace the flaskBaseUrl value with the appropriate Flask API server connection string.:

 [Server]
 flask_base_url = http://xyz:1234
 
 [User]
 current_user = bob@gmail.com

Usage

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

    ./res-cli

Commands

  • Login: Logs in to the specified user account.
    ./res-cli login # Enter email and password when prompted
  • Logout: Logs out from the current user account.
    ./res-cli logout
  • Create Instance: Creates a new ResDB or Python SDK instance.
    ./res-cli create_instance <type>
  • View Instances: Displays details about running instances.
    ./res-cli view_instances
  • Delete Instance: Deletes a running ResDB or Python SDK instance.
    ./res-cli delete_instance <instance_id>
  • Current User: Displays the currently logged-in user.
    ./res-cli whoami

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