Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
194 changes: 187 additions & 7 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "rbxcloud"
version = "0.16.0"
version = "0.17.0"
description = "CLI and SDK for the Roblox Open Cloud APIs"
authors = ["Stephen Leitnick"]
license = "MIT"
Expand All @@ -18,3 +18,5 @@ reqwest = { version = "0.12.2", default-features = false, features = ["rustls-tl
serde = { version = "1.0.197", features = ["derive"] }
serde_json = "1.0.115"
tokio = { version = "1.36.0", features = ["full"] }
chrono = { version = "0.4.38", features = ["serde"] }
rand = "0.9.0"
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,18 @@ Possible use-cases:

| | API v2 |
| -- | -- |
| :x: | Data Stores |
| :white_check_mark: | Groups |
| :white_check_mark: | Universes |
| :white_check_mark: | Places |
| :x: | Instances |
| :white_check_mark: | Subscriptions |
| :x: | Inventory |
| :white_check_mark: | Inventory |
| :white_check_mark: | User Notifications |
| :white_check_mark: | User |
| :white_check_mark: | User Restrictions |
| :x: | Creator Store |
| :x: | Luau Execution |
| :white_check_mark: | Luau Execution |

- :white_check_mark: = Supported
- :x: = Not yet supported
Expand All @@ -45,7 +47,7 @@ The goal of this project is to support all API endpoints that Roblox provides.
### 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/rbxcloud@0.16.0
$ aftman add Sleitnick/rbxcloud@0.17.0
```

### From Release
Expand All @@ -62,7 +64,7 @@ The library built for the CLI tool is available to use directly in Rust projects
To use `rbxcloud` in a Rust project, simply add `rbxcloud` to the `Cargo.toml` dependency list.
```toml
[dependencies]
rbxcloud = "0.16.0"
rbxcloud = "0.17.0"
```

Alternatively, use `cargo add`.
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/cli-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ There are a few different ways to install the `rbxcloud` CLI.
### [Aftman](https://github.com/LPGhatguy/aftman) <small>(Preferred)</small>
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/rbxcloud@0.16.0
$ aftman add Sleitnick/rbxcloud@0.17.0
```

Next, run `aftman install` to install `rbxcloud`.
Expand All @@ -17,7 +17,7 @@ Add `rbxcloud` under the `[tools]` section of your `foreman.toml` file.
```toml
# foreman.toml
[tools]
rbxcloud = { github = "Sleitnick/rbxcloud", version = "0.16.0" }
rbxcloud = { github = "Sleitnick/rbxcloud", version = "0.17.0" }
```

Next, run `foreman install` to install `rbxcloud`.
Expand Down
17 changes: 17 additions & 0 deletions docs/cli/cli-inventory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Inventory API

## List
List inventory items for a given user.

```
Usage: rbxcloud inventory list [OPTIONS] --user-id <USER_ID> --api-key <API_KEY>

Options:
-u, --user-id <USER_ID> Roblox user ID
-p, --pretty Pretty-print the JSON response
-m, --max-page-size <MAX_PAGE_SIZE> Max page size
-n, --page-token <PAGE_TOKEN> Next page token
-f, --filter <FILTER> Filter string
-a, --api-key <API_KEY> Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
-h, --help Print help
```
Loading