Google Git
Sign in
apache / incubator-resilientdb-ResCLI / refs/heads/workflow_fix
commite2f4c63c1ac70433e3978c372e6c21a1bb2c7a6b[log] [tgz]
authorGopal Nambiar <gopalnambiar2@gmail.com>Wed Feb 28 14:52:25 2024 -0800
committerGopal Nambiar <gopalnambiar2@gmail.com>Wed Feb 28 14:52:25 2024 -0800
tree9a637becf45f7ab84e9615db804633397e18775c
parent4ffeab7a2968c0128676aadf37fc8b1b494f3ed7 [diff]
Readme minor changes
1 file changed
tree: 9a637becf45f7ab84e9615db804633397e18775c
  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

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

  • 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.