https://github.com/Sleitnick/rbxcloud

CLI and library for Roblox Open Cloud API
https://github.com/Sleitnick/rbxcloud

api cli cloud open roblox

Last synced: 5 days ago
JSON representation

CLI and library for Roblox Open Cloud API

• Host: GitHub
• URL: https://github.com/Sleitnick/rbxcloud
• Owner: Sleitnick
• License: mit
• Created: 2022-07-26T18:00:01.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-14T17:47:01.000Z (3 months ago)
• Last Synced: 2024-10-24T22:18:05.259Z (20 days ago)
• Topics: api, cli, cloud, open, roblox
• Language: Rust
• Homepage: https://sleitnick.github.io/rbxcloud/
• Size: 838 KB
• Stars: 100
• Watchers: 6
• Forks: 11
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-roblox - rbxcloud - CLI and library for Roblox Open Cloud API. (Libraries / Open Cloud)

README

        
# 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?event=push)](https://github.com/Sleitnick/rbxcloud/actions/workflows/release.yaml)

[![Crate](https://img.shields.io/crates/v/rbxcloud.svg)](https://crates.io/crates/rbxcloud)

[![Docs](https://docs.rs/rbxcloud/badge.svg)](https://docs.rs/rbxcloud)

The `rbxcloud` CLI lets developers easily communicate with the Roblox Open Cloud APIs. The underlying library can also be used to build tools and applications that utilize the various APIs.

Possible use-cases:

- Deployment pipelines

- Asset management

- Live-ops

- Custom analytics

- Handling data removal requests (see [GDPR & CCPA info](https://create.roblox.com/docs/production/publishing/about-GDPR-and-CCPA))

- Debugging DataStores and OrderedDataStores

## Supported APIs

| | API v1 |

| -- | -- |

| :white_check_mark: | Assets |

| :white_check_mark: | Data Stores |

| :white_check_mark: | Messaging |

| :white_check_mark: | Place Publishing |

| | API v2 (Beta) |

| -- | -- |

| :white_check_mark: | Groups |

| :white_check_mark: | Universes |

| :white_check_mark: | Places |

| :x: | Instances |

| :white_check_mark: | Subscriptions |

| :x: | Inventory |

| :white_check_mark: | User Notifications |

| :white_check_mark: | User |

| :x: | Creator Store |

- :white_check_mark: = Supported

- :x: = Not yet supported

The goal of this project is to support all API endpoints that Roblox provides.

## Install CLI

### Aftman

Run the `aftman add` command within your project directory. This will add `rbxcloud` to the project's `aftman.toml` file (or create one if it doesn't yet exist).

```sh

$ aftman add Sleitnick/[email protected]

```

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

## CLI Documentation

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

## Install Rust Library

The library built for the CLI tool is available to use directly in Rust projects. This is essentially an SDK for the Roblox Open Cloud APIs.

### Add Dependency

To use `rbxcloud` in a Rust project, simply add `rbxcloud` to the `Cargo.toml` dependency list.

```toml

[dependencies]

rbxcloud = "0.14.0"

```

Alternatively, use `cargo add`.

```sh

$ cargo add rbxcloud

```

See the [docs.rs](https://docs.rs/rbxcloud/latest/rbxcloud/) page for library documentation.