https://github.com/resilientapp/rescli
https://github.com/resilientapp/rescli
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/resilientapp/rescli
- Owner: ResilientApp
- License: apache-2.0
- Created: 2023-12-03T09:16:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-28T21:42:58.000Z (over 1 year ago)
- Last Synced: 2025-04-23T07:14:44.986Z (about 1 year ago)
- Language: Ruby
- Size: 37.7 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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`.