Skip to content

Commit

Permalink
CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jackTabsCode committed Jun 29, 2024
1 parent 06f603d commit 2b9db3f
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions docs/cli/cli-place.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Universe API

## Getting Place Info
```
Usage: rbxcloud place get [OPTIONS] --universe-id <UNIVERSE_ID> --place-id <PLACE_ID> --api-key <API_KEY>
Options:
-u, --universe-id <UNIVERSE_ID> Universe ID
-p, --place-id <PLACE_ID> Place ID
--pretty Pretty-print the JSON response
-a, --api-key <API_KEY> Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
-h, --help Print help
```

### Example
```
$ rbxcloud place get -u 12345 -p 67890 -a MY_KEY
```

## Updating Name
```
Usage: rbxcloud place update-name [OPTIONS] --universe-id <UNIVERSE_ID> --place-id <PLACE_ID> --name <NAME> --api-key <API_KEY>
Options:
-u, --universe-id <UNIVERSE_ID> Universe ID
-p, --place-id <PLACE_ID> Place ID
-n, --name <NAME> New Place name
--pretty Pretty-print the JSON response
-a, --api-key <API_KEY> Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
-h, --help Print help
```

### Example
```
$ rbxcloud place update-name -n "Place Name" -u 12345 -p 67890 -a MY_KEY
```

## Updating Description
```
Usage: rbxcloud place update-description [OPTIONS] --universe-id <UNIVERSE_ID> --place-id <PLACE_ID> --description <DESCRIPTION> --api-key <API_KEY>
Options:
-u, --universe-id <UNIVERSE_ID> Universe ID
-p, --place-id <PLACE_ID> Place ID
-d, --description <DESCRIPTION> New Place description
--pretty Pretty-print the JSON response
-a, --api-key <API_KEY> Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
-h, --help Print help
```

### Example
```
$ rbxcloud universe update-description -n "Place description here." -u 12345 -p 67890 -a MY_KEY
```

0 comments on commit 2b9db3f

Please sign in to comment.