You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: region-neutral user-facing docs (remove region machinery + cross-refs) (#51)
Align CLI/MCP/SDK/setup docs with website doc policy:
- No internal region setup wording (QVERIS_REGION, sk-cn vs sk-xxx region
table, region-selection UI, config/region.mjs, region auto-detect copy).
- No cross-region references: Global docs (docs/en-US, docs/zh-CN) present
only the qveris.ai world; CN docs (docs/cn/zh-CN) present only the
qveris.cn world. Removed dual-site footers, 'China region example',
python-sdk 'global default vs China' framing, sk-cn key prefixes.
- Provider-level 'region' capability attribute (alongside success_rate /
latency / billing_rule) kept — it is a product field, not site region.
Files: cli.md, mcp-server.md, python-sdk.md, ide-cli-setup.md across
docs/en-US + docs/zh-CN + docs/cn/zh-CN. Verified: no region machinery /
cross-region refs remain in either world.
Authenticate with your QVeris API key. If no region is pre-configured, prompts you to select your region (Global or China), then opens the browser to the corresponding API key page and prompts for masked input.
271
+
Authenticate with your QVeris API key. Opens the browser to the API key page and prompts for masked input.
272
272
273
273
```bash
274
274
qveris login [flags]
275
275
```
276
276
277
277
| Flag | Description |
278
278
|------|-------------|
279
-
|`--token <key>`| Provide key directly (skip browser and region prompt) |
279
+
|`--token <key>`| Provide key directly (skip browser prompt) |
280
280
|`--no-browser`| Don't open browser |
281
281
282
282
```bash
283
-
# Interactive (select region → opens browser → masked input)
283
+
# Interactive (opens browser → masked input)
284
284
qveris login
285
285
286
286
# Non-interactive
287
287
qveris login --token "sk-1_your-key-here"
288
288
```
289
289
290
-
During interactive login, if `QVERIS_REGION` or `--base-url` is not set, you will be prompted:
291
-
292
-
```
293
-
Select your region / 选择站点区域:
294
-
295
-
1) Global — qveris.ai (International users)
296
-
2) China — qveris.cn (中国大陆用户)
297
-
298
-
Enter 1 or 2:
299
-
```
300
-
301
290
The key is saved to `~/.config/qveris/config.json` with `0600` permissions (owner-only).
302
291
303
292
### `qveris logout`
@@ -310,7 +299,7 @@ qveris logout
310
299
311
300
### `qveris whoami`
312
301
313
-
Show current auth status, key source, resolved region, and validate against the API.
302
+
Show current auth status and key source, and validate against the API.
314
303
315
304
```bash
316
305
qveris whoami
@@ -422,7 +411,7 @@ qveris> exit
422
411
423
412
### `qveris doctor`
424
413
425
-
Self-check diagnostics: verifies Node.js version, API key configuration, resolved region and base URL, and API connectivity.
414
+
Self-check diagnostics: verifies Node.js version, API key configuration, base URL, and API connectivity.
426
415
427
416
```bash
428
417
qveris doctor
@@ -497,8 +486,7 @@ Use `--` to end option parsing: `qveris discover -- --literal-query`.
497
486
| Variable | Description | Default |
498
487
|----------|-------------|---------|
499
488
|`QVERIS_API_KEY`| API authentication key | — |
500
-
|`QVERIS_REGION`| Force region: `global` or `cn`| auto from key |
501
-
|`QVERIS_BASE_URL`| Override API base URL | auto from region |
489
+
|`QVERIS_BASE_URL`| Override API base URL | auto from key |
|`XDG_CONFIG_HOME`| Config directory base |`~/.config`|
@@ -509,43 +497,13 @@ Use `--` to end option parsing: `qveris discover -- --literal-query`.
509
497
510
498
---
511
499
512
-
## Region
513
-
514
-
Region is auto-detected from your API key prefix. No extra configuration needed.
515
-
516
-
| Key prefix | Region | Base URL |
517
-
|------------|--------|----------|
518
-
|`sk-xxx`| Global |`https://qveris.ai/api/v1`|
519
-
|`sk-cn-xxx`| China |`https://qveris.cn/api/v1`|
520
-
521
-
**Interactive login:** When running `qveris login` without `QVERIS_REGION` or `--base-url`, you'll be prompted to choose a region. This is for first-time human users only.
522
-
523
-
**Agent / script usage:** Agents and scripts should skip the interactive prompt. Region is resolved automatically:
0 commit comments