diff --git a/docs/cli/cli-place.md b/docs/cli/cli-place.md new file mode 100644 index 0000000..9b6c278 --- /dev/null +++ b/docs/cli/cli-place.md @@ -0,0 +1,54 @@ +# Universe API + +## Getting Place Info +``` +Usage: rbxcloud place get [OPTIONS] --universe-id --place-id --api-key + +Options: + -u, --universe-id Universe ID + -p, --place-id Place ID + --pretty Pretty-print the JSON response + -a, --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 --place-id --name --api-key + +Options: + -u, --universe-id Universe ID + -p, --place-id Place ID + -n, --name New Place name + --pretty Pretty-print the JSON response + -a, --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 --place-id --description --api-key + +Options: + -u, --universe-id Universe ID + -p, --place-id Place ID + -d, --description New Place description + --pretty Pretty-print the JSON response + -a, --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 +```