Elgato_dark/Olares
1
0
Fork 0
mirror of https://github.com/beclab/Olares synced 2026-04-21 21:47:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
Olares/docs/developer/install/cli/backups-region.md
Meow33 8133704761
docs: add CLI docs for user, upgrade, and disk commands (#2383) 
* docs: add CLI docs for user, upgrade, and disk commands

* docs: update based on comments

* docs: fix typo

* docs: refine formatting and add description for argument

* docs: resolve conflicts
2026-01-13 17:30:57 +08:00

1.4 KiB
Raw Blame History

region

Synopsis

The region subcommand is used to retrieve the cloud name and region ID. It is specifically used when the storage backend is Olares Space.

olares-cli backups region space [options]

Options

Option Shorthand Usage Required Default
--access-token 1 Specifies the access token for Olares Space. No N/A
--cloud-api-mirror Specifies the cloud API mirror. No N/A
--help -h Displays help information. No N/A
--olares-did 1 Specifies the Olares DID. No N/A
  1. To retrieve the access token and Olares DID, inspect the payload of the network requests made by the Olares Space web interface after logging in. The token field corresponds to the access token, and the userid field corresponds to the Olares DID.

Examples

# Query cloud name and region ID
olares-cli backups region space \
  --access-token YOUR_ACCESS_TOKEN \
  --cloud-api-mirror https://api-mirror.example.com \
  --olares-did did:xyz123