Skip to content

Commit 8a8a295

Browse files
Merge pull request #497 from authzed/docs-spicedb-update
Auto-generated PR: Update spicedb docs
2 parents d59daeb + fa58799 commit 8a8a295

File tree

1 file changed

+36
-12
lines changed

1 file changed

+36
-12
lines changed

app/spicedb/concepts/commands/page.mdx

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,14 @@ A database that stores and computes permissions
2727

2828
### Children commands
2929

30-
- [spicedb datastore](#reference-spicedb-datastore) - datastore operations
31-
- [spicedb lsp](#reference-spicedb-lsp) - serve language server protocol
32-
- [spicedb man](#reference-spicedb-man) - Generate man page
33-
- [spicedb postgres-fdw](#reference-spicedb-postgres-fdw) - serve a Postgres Foreign Data Wrapper for SpiceDB (EXPERIMENTAL)
34-
- [spicedb serve](#reference-spicedb-serve) - serve the permissions database
35-
- [spicedb serve-testing](#reference-spicedb-serve-testing) - test server with an in-memory datastore
36-
- [spicedb version](#reference-spicedb-version) - displays the version of SpiceDB
30+
- [spicedb datastore](#reference-spicedb-datastore) - datastore operations
31+
- [spicedb lsp](#reference-spicedb-lsp) - serve language server protocol
32+
- [spicedb man](#reference-spicedb-man) - Generate man page
33+
- [spicedb postgres-fdw](#reference-spicedb-postgres-fdw) - serve a Postgres Foreign Data Wrapper for SpiceDB (EXPERIMENTAL)
34+
- [spicedb serve](#reference-spicedb-serve) - serve the permissions database
35+
- [spicedb serve-testing](#reference-spicedb-serve-testing) - test server with an in-memory datastore
36+
- [spicedb version](#reference-spicedb-version) - displays the version of SpiceDB
37+
3738

3839
## Reference: `spicedb datastore`
3940

@@ -49,10 +50,11 @@ Operations against the configured datastore
4950

5051
### Children commands
5152

52-
- [spicedb datastore gc](#reference-spicedb-datastore-gc) - executes garbage collection
53-
- [spicedb datastore head](#reference-spicedb-datastore-head) - compute the head (latest) database migration revision available
54-
- [spicedb datastore migrate](#reference-spicedb-datastore-migrate) - execute datastore schema migrations
55-
- [spicedb datastore repair](#reference-spicedb-datastore-repair) - executes datastore repair
53+
- [spicedb datastore gc](#reference-spicedb-datastore-gc) - executes garbage collection
54+
- [spicedb datastore head](#reference-spicedb-datastore-head) - compute the head (latest) database migration revision available
55+
- [spicedb datastore migrate](#reference-spicedb-datastore-migrate) - execute datastore schema migrations
56+
- [spicedb datastore repair](#reference-spicedb-datastore-repair) - executes datastore repair
57+
5658

5759
## Reference: `spicedb datastore gc`
5860

@@ -143,6 +145,8 @@ spicedb datastore gc [flags]
143145
--skip-release-check if true, skips checking for new SpiceDB releases
144146
```
145147

148+
149+
146150
## Reference: `spicedb datastore head`
147151

148152
compute the head (latest) database migration revision available
@@ -174,6 +178,8 @@ spicedb datastore head [flags]
174178
--skip-release-check if true, skips checking for new SpiceDB releases
175179
```
176180

181+
182+
177183
## Reference: `spicedb datastore migrate`
178184

179185
Executes datastore schema migrations for the datastore.
@@ -213,6 +219,8 @@ spicedb datastore migrate [revision] [flags]
213219
--skip-release-check if true, skips checking for new SpiceDB releases
214220
```
215221

222+
223+
216224
## Reference: `spicedb datastore repair`
217225

218226
Executes a repair operation for the datastore
@@ -302,6 +310,8 @@ spicedb datastore repair [flags]
302310
--skip-release-check if true, skips checking for new SpiceDB releases
303311
```
304312

313+
314+
305315
## Reference: `spicedb lsp`
306316

307317
serve language server protocol
@@ -325,17 +335,20 @@ spicedb lsp [flags]
325335
--skip-release-check if true, skips checking for new SpiceDB releases
326336
```
327337

338+
339+
328340
## Reference: `spicedb man`
329341

330342
Generate a man page for SpiceDB.
331-
The output can be redirected to a file and installed to the system:
343+
The output can be redirected to a file and installed to the system:
332344

333345
```
334346
spicedb man > spicedb.1
335347
sudo mv spicedb.1 /usr/share/man/man1/
336348
sudo mandb # Update man page database
337349
```
338350

351+
339352
```
340353
spicedb man
341354
```
@@ -348,6 +361,8 @@ spicedb man
348361
--skip-release-check if true, skips checking for new SpiceDB releases
349362
```
350363

364+
365+
351366
## Reference: `spicedb postgres-fdw`
352367

353368
EXPERIMENTAL: Serves a Postgres-compatible interface for querying SpiceDB data using foreign data wrappers. This feature is experimental and subject to change.
@@ -376,6 +391,8 @@ spicedb postgres-fdw [flags]
376391
--skip-release-check if true, skips checking for new SpiceDB releases
377392
```
378393

394+
395+
379396
## Reference: `spicedb serve`
380397

381398
start a SpiceDB server
@@ -560,6 +577,8 @@ spicedb serve [flags]
560577
--skip-release-check if true, skips checking for new SpiceDB releases
561578
```
562579

580+
581+
563582
## Reference: `spicedb serve-testing`
564583

565584
An in-memory spicedb server which serves completely isolated datastores per client-supplied auth token used.
@@ -621,6 +640,8 @@ spicedb serve-testing [flags]
621640
--skip-release-check if true, skips checking for new SpiceDB releases
622641
```
623642

643+
644+
624645
## Reference: `spicedb version`
625646

626647
displays the version of SpiceDB
@@ -642,3 +663,6 @@ spicedb version [flags]
642663
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
643664
--skip-release-check if true, skips checking for new SpiceDB releases
644665
```
666+
667+
668+

0 commit comments

Comments
 (0)