Skip to content

Commit 7409b73

Browse files
committed
docs: fix CLI reference accuracy issues from cross-check
- Fix teleport serve: --listen-addr default to "localhost:9876" (not "0.0.0.0"), --dblab-url to optional with default, --webhook-secret to required (matches code) - Remove incorrect --force flag from snapshot delete CLI docs — force deletion is only available via API/UI, not CLI - Fix init --token from required to optional (code doesn't enforce it) https://claude.ai/code/session_011sPDgBjzL2N2X6jiYyoTjQ
1 parent 9d440c1 commit 7409b73

2 files changed

Lines changed: 12 additions & 19 deletions

File tree

docs/dblab-howtos/snapshots/delete-snapshot.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,9 @@ Delete a snapshot with `dblab snapshot` command, using subcommand `delete`.
3333
$ dblab snapshot delete SNAPSHOT_ID
3434
```
3535

36-
### Force-delete a snapshot with dependent clones
37-
If the snapshot has dependent clones or datasets, use `--force`:
38-
39-
```bash
40-
$ dblab snapshot delete --force SNAPSHOT_ID
41-
```
36+
:::tip
37+
If the snapshot has dependent clones, you can force-delete it via the GUI (see screenshots above) or via the API (`DELETE /snapshot/{id}?force=true`).
38+
:::
4239

4340
## Related
4441
- Guide: [Create a snapshot](/docs/dblab-howtos/snapshots/create-snapshot)

docs/reference-guides/dblab-client-cli-reference.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,12 @@ dblab init [command options] [arguments...]
111111
**Options**
112112
- `--environment-id` (string, required) - an arbitrary environment ID of Database Lab instance's API
113113
- `--url` (string, required) - URL of Database Lab instance's API
114-
- `--token` (string, required) - verification token of Database Lab instance
114+
- `--token` (string, optional) - verification token of Database Lab instance
115115
- `--insecure` (boolean, optional, default: false) - allow insecure server connections when using SSL
116116
- `--request-timeout` (string, optional, default: "") - change requests timeout
117117
- `--forwarding-server-url` (string, optional) - forwarding server URL of Database Lab instance. For example: `ssh://user@remote.host:22`
118118
- `--forwarding-local-port` (string, optional) - local port for forwarding to the Database Lab instance
119-
- `--identity-file` (string, optional) - select a file from which the identity (private key) for public key authentication is read"
119+
- `--identity-file` (string, optional) - select a file from which the identity (private key) for public key authentication is read
120120

121121
**Example**
122122
```bash
@@ -644,22 +644,18 @@ Delete a snapshot.
644644

645645
**Usage**
646646
```bash
647-
dblab snapshot delete [command options] SNAPSHOT_ID
647+
dblab snapshot delete SNAPSHOT_ID
648648
```
649649

650-
**Options**
651-
- `--force` (boolean, default: false) - force deletion even if dependent clones or datasets exist
652-
653650
**Example**
654651

655652
```bash
656653
dblab snapshot delete "dblab_pool/dataset_1@snapshot_20241028174127"
657654
```
658655

659-
Force delete a snapshot with dependent clones:
660-
```bash
661-
dblab snapshot delete --force "dblab_pool/dataset_1@snapshot_20241028174127"
662-
```
656+
:::tip
657+
Force deletion of snapshots with dependent clones is available through the API (`DELETE /snapshot/{id}?force=true`) or the UI, but is not currently supported via the CLI.
658+
:::
663659

664660
---
665661
### Subcommand `help` , `h`
@@ -700,10 +696,10 @@ dblab teleport serve [command options]
700696
- `--environment-id` (string, required) - environment identifier used in Teleport resource names
701697
- `--teleport-proxy` (string, required) - Teleport Auth Server or Proxy address (e.g., `teleport.example.com:3025`)
702698
- `--teleport-identity` (string, required) - path to the Teleport bot identity file for authentication
703-
- `--listen-addr` (string, optional, default: "0.0.0.0:9876") - address and port to listen for incoming webhooks
704-
- `--dblab-url` (string, required) - DBLab API URL (e.g., `http://localhost:2345`)
699+
- `--listen-addr` (string, optional, default: "localhost:9876") - address and port to listen for incoming webhooks. Use `0.0.0.0:9876` if the sidecar needs to be reachable from Docker containers.
700+
- `--dblab-url` (string, optional, default: "http://localhost:2345") - DBLab API URL
705701
- `--dblab-token` (string, required) - DBLab verification token
706-
- `--webhook-secret` (string, optional) - webhook secret for verifying incoming webhook payloads
702+
- `--webhook-secret` (string, required) - shared secret that DBLab Engine sends in the `DBLab-Webhook-Token` header for webhook payload verification
707703

708704
**Example**
709705
```bash

0 commit comments

Comments
 (0)