eliott/Olares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add docs to main (#1559)

Browse Source
This commit is contained in:
Peng Peng
2025-07-17 11:58:59 +08:00
committed by GitHub
parent e00018de59
commit af8e3b172c
1037 changed files with 40779 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/developer/install/cli/backups-region.md Normal file
View File

@@ -0,0 +1,27 @@
# `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.
```bash
olares-cli backups region space [options]
```
## Options
| Option | Shorthand | Usage | Required | Default |
|-------------------------------|-----------|----------------------------------------------|-------------------------|---------|
| `--access-token` <sup>1</sup> | | 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` <sup>1</sup> | | 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.
## Example
```bash
# 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
```