Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/resilientapp/rescli

Last synced: 29 days ago
JSON representation

Host: GitHub
URL: https://github.com/resilientapp/rescli
Owner: ResilientApp
License: apache-2.0
Created: 2023-12-03T09:16:20.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-08-27T21:44:58.000Z (5 months ago)
Last Synced: 2024-08-27T23:20:46.147Z (5 months ago)
Language: Ruby
Size: 37.7 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

![](https://img.shields.io/github/v/release/ResilientApp/ResCLI)
![](https://img.shields.io/badge/language-ruby-orange.svg)
![](https://img.shields.io/badge/platform-Ubuntu20.0+-lightgrey.svg)
![GitHub](https://img.shields.io/github/license/ResilientApp/ResCLI)

# 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](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Commands](#commands)

## Installation

To use `ResCLI`, you can download the binary from the [Releases](https://github.com/ResilientApp/ResCLI/releases) page on GitHub.

1. Go to the [Releases](https://github.com/ResilientApp/ResCLI/releases) page.
2. Download the latest release for your operating system (e.g., `res-cli-linux` for Linux).
3. Make the downloaded binary executable:

```bash
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:

```bash
./res-cli
```

## Commands

- **Login**: Logs in to the specified user account.

```bash
./res-cli --login # Enter email and password when prompted
```

- **Logout**: Logs out from the current user account.

```bash
./res-cli --logout
```

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

```bash
./res-cli --create
```

- **View Instances**: Displays details about running instances.

```bash
./res-cli --view-instances
```

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

```bash
./res-cli --delete
```

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

```bash
./res-cli --whoami
```

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