Skip to content

Latest commit

 

History

History
72 lines (57 loc) · 2.69 KB

README.md

File metadata and controls

72 lines (57 loc) · 2.69 KB
Raw

Roblox Open Cloud CLI   Logo

CI Release Crate Docs

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)
  • Debugging DataStores and OrderedDataStores

Supported APIs

API v1
✅ Assets
✅ Data Stores
✅ Messaging
✅ Place Publishing
API v2 (Beta)
✅ Groups
✅ Universes
✅ Places
❌ Instances
✅ Subscriptions
❌ Inventory
✅ User Notifications
✅ User
❌ Creator Store
  • ✅ = Supported
  • ❌ = 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).

$ aftman add Sleitnick/[email protected]

From Release

Download and unzip the tool for your OS from the 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.

[dependencies]
rbxcloud = "0.14.0"

Alternatively, use cargo add.

$ cargo add rbxcloud

See the docs.rs page for library documentation.