rbxcloud 0.1.0-alpha.10

CLI for the Roblox Open Cloud APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

# Roblox Open Cloud CLI   ![Logo](imgs/icon_32_bottom.png)
[![CI](https://github.com/Sleitnick/rbxcloud/actions/workflows/ci.yaml/badge.svg)](https://github.com/Sleitnick/rbxcloud/actions/workflows/ci.yaml)
[![Release](https://github.com/Sleitnick/rbxcloud/actions/workflows/release.yaml/badge.svg)](https://github.com/Sleitnick/rbxcloud/actions/workflows/release.yaml)

:warning: Under Development :warning:

The `rbxcloud` CLI lets developers easily communicate with the Roblox Open Cloud APIs.

Common use-cases:
- CD pipelines
- Debugging DataStores
- _TODO: More use-cases_

## Install
### Foreman
Add `rbxcloud` under the `[tools]` section of your `foreman.toml` file:
```toml
rbxcloud = { github = "Sleitnick/rbxcloud", version = "0.1.0-alpha.10" }
```

### Cargo
Install from cargo:
```sh
$ cargo install rbxcloud@0.1.0-alpha.10
```

### From Release
Download and unzip the tool for your OS from the [releases](https://github.com/Sleitnick/rbxcloud/releases) page. You will then need to put it in your desired location and point your path variable to the executable location.

### From Source
Download the repository and build from the source:
```sh
# Clone repo and set as current directory:
$ git clone https://github.com/Sleitnick/rbxcloud.git
$ cd rbxcloud

# Build binary:
$ cargo build --release
```

## Documentation
Visit the documentation site for information on installation and usage: https://sleitnick.github.io/rbxcloud/