Google Git
Sign in
apache / incubator-resilientdb-ResCLI / refs/heads/Linux-bin
commite1cb4c1720c3b35d8a30973d75b1ce39bc9142d4[log] [tgz]
authorgopuman <gopuman@node0.gopuman-182286.resilientdb-pg0.utah.cloudlab.us>Sun Dec 03 17:57:26 2023 -0700
committergopuman <gopuman@node0.gopuman-182286.resilientdb-pg0.utah.cloudlab.us>Sun Dec 03 17:57:26 2023 -0700
treec0aa7d4e6f716cf69a89bf77605db886039051b2
parentaf0ed4d1ea66e3dc9c06458f4ccba3d1e68fbebe [diff]
Added linux binary
1 file changed
tree: c0aa7d4e6f716cf69a89bf77605db886039051b2
  1. dist/
  2. config.ini
  3. README.md
  4. resdb_cli.py
README.md

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

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.