Skip to content

Commit c3e87bb

Browse files
miparnisarigithub-actions[bot]
authored andcommitted
[create-pull-request] automated change
1 parent 336e5db commit c3e87bb

File tree

1 file changed

+99
-67
lines changed

1 file changed

+99
-67
lines changed

pages/spicedb/getting-started/installing-zed.mdx

Lines changed: 99 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,7 @@ Manage configurations for connecting to SpiceDB deployments
460460
### Children commands
461461

462462
- [zed context list](#reference-zed-context-list) - Lists all available contexts
463-
- [zed context remove](#reference-zed-context-remove) - Removes a context
463+
- [zed context remove](#reference-zed-context-remove) - Removes a context by name
464464
- [zed context set](#reference-zed-context-set) - Creates or overwrite a context
465465
- [zed context use](#reference-zed-context-use) - Sets a context as the current context
466466

@@ -502,10 +502,10 @@ zed context list [flags]
502502

503503
## Reference: `zed context remove`
504504

505-
Removes a context
505+
Removes a context by name
506506

507507
```
508-
zed context remove <system>
508+
zed context remove <name>
509509
```
510510

511511
### Options Inherited From Parent Flags
@@ -563,7 +563,7 @@ zed context set <name> <endpoint> <api-token>
563563
Sets a context as the current context
564564

565565
```
566-
zed context use <system>
566+
zed context use <name>
567567
```
568568

569569
### Options Inherited From Parent Flags
@@ -662,7 +662,7 @@ zed import <url> [flags]
662662
## Reference: `zed mcp`
663663

664664
MCP (Model Context Protocol) server commands.
665-
665+
666666
The MCP server provides tooling and resources for developing and debugging SpiceDB schema and relationships. The server runs an in-memory development instance of SpiceDB and does not connect to a running instance of SpiceDB.
667667

668668
To use with Claude Code, run `zed mcp experimental-run` to start the SpiceDB Dev MCP server and then run `claude mcp add --transport http spicedb "http://localhost:9999/mcp"` to add the server to your Claude Code integrations.
@@ -751,16 +751,16 @@ Query the permissions in a permissions system
751751

752752
### Children commands
753753

754-
- [zed permission bulk](#reference-zed-permission-bulk) - Check permissions in bulk exist for resource-subject pairs
755-
- [zed permission check](#reference-zed-permission-check) - Check that a permission exists for a subject
754+
- [zed permission bulk](#reference-zed-permission-bulk) - Check permissions in bulk exist for resource-permission-subject triplets
755+
- [zed permission check](#reference-zed-permission-check) - Check if a subject has permission on a resource
756756
- [zed permission expand](#reference-zed-permission-expand) - Expand the structure of a permission
757-
- [zed permission lookup-resources](#reference-zed-permission-lookup-resources) - Enumerates the resources of a given type for which the subject has permission
757+
- [zed permission lookup-resources](#reference-zed-permission-lookup-resources) - Enumerates the resources of a given type for which a subject has permission
758758
- [zed permission lookup-subjects](#reference-zed-permission-lookup-subjects) - Enumerates the subjects of a given type for which the subject has permission on the resource
759759

760760

761761
## Reference: `zed permission bulk`
762762

763-
Check permissions in bulk exist for resource-subject pairs
763+
Check permissions in bulk exist for resource-permission-subject triplets
764764

765765
```
766766
zed permission bulk <resource:id#permission@subject:id> <resource:id#permission@subject:id> ... [flags]
@@ -802,7 +802,7 @@ zed permission bulk <resource:id#permission@subject:id> <resource:id#permission@
802802

803803
## Reference: `zed permission check`
804804

805-
Check that a permission exists for a subject
805+
Check if a subject has permission on a resource
806806

807807
```
808808
zed permission check <resource:id> <permission> <subject:id> [flags]
@@ -885,7 +885,7 @@ zed permission expand <permission> <resource:id> [flags]
885885

886886
## Reference: `zed permission lookup-resources`
887887

888-
Enumerates the resources of a given type for which the subject has permission
888+
Enumerates the resources of a given type for which a subject has permission
889889

890890
```
891891
zed permission lookup-resources <type> <permission> <subject:id> [flags]
@@ -968,6 +968,52 @@ zed permission lookup-subjects <resource:id> <permission> <subject_type#optional
968968

969969

970970

971+
## Reference: `zed preview schema compile`
972+
973+
Compile a schema that uses extended syntax into one that can be written to SpiceDB
974+
975+
```
976+
zed preview schema compile <file> [flags]
977+
```
978+
979+
### Examples
980+
981+
```
982+
983+
Write to stdout:
984+
zed preview schema compile root.zed
985+
Write to an output file:
986+
zed preview schema compile root.zed --out compiled.zed
987+
988+
```
989+
990+
### Options
991+
992+
```
993+
--out string output filepath; omitting writes to stdout
994+
```
995+
996+
### Options Inherited From Parent Flags
997+
998+
```
999+
--certificate-path string path to certificate authority used to verify secure connections
1000+
--endpoint string spicedb gRPC API endpoint
1001+
--hostname-override string override the hostname used in the connection to the endpoint
1002+
--insecure connect over a plaintext connection
1003+
--log-format string format of logs ("auto", "console", "json") (default "auto")
1004+
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
1005+
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
1006+
--max-retries uint maximum number of sequential retries to attempt when a request fails (default 10)
1007+
--no-verify-ca do not attempt to verify the server's certificate chain and host name
1008+
--permissions-system string permissions system to query
1009+
--proxy string specify a SOCKS5 proxy address
1010+
--request-id string optional id to send along with SpiceDB requests for tracing
1011+
--skip-version-check if true, no version check is performed against the server
1012+
--token string token used to authenticate to SpiceDB
1013+
```
1014+
1015+
1016+
9711017
## Reference: `zed relationship`
9721018

9731019
Query and mutate the relationships in a permissions system
@@ -1046,6 +1092,15 @@ Create a relationship for a subject
10461092
zed relationship create <resource:id> <relation> <subject:id#optional_subject_relation> [flags]
10471093
```
10481094

1095+
### Examples
1096+
1097+
```
1098+
1099+
zed relationship create document:budget view user:anne --expiration-time "2025-12-31T23:59:59Z"
1100+
zed relationship create document:budget view user:anne --caveat ip_address:'{"ip": "192.168.0.1"}
1101+
1102+
```
1103+
10491104
### Options
10501105

10511106
```
@@ -1114,15 +1169,19 @@ zed relationship delete <resource:id> <relation> <subject:id#optional_subject_re
11141169

11151170
## Reference: `zed relationship read`
11161171

1117-
Enumerates relationships matching the provided pattern.
1172+
Enumerates relationships matching the provided pattern
11181173

1119-
To filter returned relationships using a resource ID prefix, append a '%' to the resource ID:
1120-
1121-
zed relationship read some-type:some-prefix-%
1174+
```
1175+
zed relationship read <resource_type:optional_resource_id> <optional_relation> <optional_subject_type:optional_subject_id#optional_subject_relation> [flags]
1176+
```
11221177

1178+
### Examples
11231179

11241180
```
1125-
zed relationship read <resource_type:optional_resource_id> <optional_relation> <optional_subject_type:optional_subject_id#optional_subject_relation> [flags]
1181+
1182+
# To filter returned relationships using a resource ID prefix, append a '%' to the resource ID.
1183+
zed relationship read document:finance-%
1184+
11261185
```
11271186

11281187
### Options
@@ -1166,6 +1225,15 @@ Idempotently updates a relationship for a subject
11661225
zed relationship touch <resource:id> <relation> <subject:id#optional_subject_relation> [flags]
11671226
```
11681227

1228+
### Examples
1229+
1230+
```
1231+
1232+
zed relationship touch document:budget view user:anne --expiration-time "2025-12-31T23:59:59Z"
1233+
zed relationship touch document:budget view user:anne --caveat ip_address:'{"ip": "192.168.0.1"}
1234+
1235+
```
1236+
11691237
### Options
11701238

11711239
```
@@ -1201,16 +1269,26 @@ zed relationship touch <resource:id> <relation> <subject:id#optional_subject_rel
12011269
Watches the stream of relationship updates and schema updates from the server
12021270

12031271
```
1204-
zed relationship watch [object_types, ...] [start_cursor] [flags]
1272+
zed relationship watch [object_types, ...] [revision] [flags]
1273+
```
1274+
1275+
### Examples
1276+
1277+
```
1278+
1279+
zed relationship watch --filter document:finance
1280+
zed relationship watch --filter document:finance#view
1281+
zed relationship watch --filter document:finance#view@user:anne
1282+
12051283
```
12061284

12071285
### Options
12081286

12091287
```
1210-
--filter optional_resource_type:optional_resource_id_or_prefix#optional_relation@optional_subject_filter optional filter(s) for the watch stream. Example: optional_resource_type:optional_resource_id_or_prefix#optional_relation@optional_subject_filter
1211-
--object_types strings optional object types to watch updates for
1212-
--revision string optional revision at which to start watching
1213-
--timestamp shows timestamp of incoming update events
1288+
--filter strings optional filter(s) for the watch stream
1289+
--object_types strings optional object types to watch updates for
1290+
--revision string optional revision at which to start watching
1291+
--timestamp shows timestamp of incoming update events
12141292
```
12151293

12161294
### Options Inherited From Parent Flags
@@ -1266,52 +1344,6 @@ Manage schema for a permissions system
12661344
- [zed schema write](#reference-zed-schema-write) - Write a schema file (.zed or stdin) to the current permissions system
12671345

12681346

1269-
## Reference: `zed schema compile`
1270-
1271-
Compile a schema that uses extended syntax into one that can be written to SpiceDB
1272-
1273-
```
1274-
zed schema compile <file> [flags]
1275-
```
1276-
1277-
### Examples
1278-
1279-
```
1280-
1281-
Write to stdout:
1282-
zed preview schema compile root.zed
1283-
Write to an output file:
1284-
zed preview schema compile root.zed --out compiled.zed
1285-
1286-
```
1287-
1288-
### Options
1289-
1290-
```
1291-
--out string output filepath; omitting writes to stdout
1292-
```
1293-
1294-
### Options Inherited From Parent Flags
1295-
1296-
```
1297-
--certificate-path string path to certificate authority used to verify secure connections
1298-
--endpoint string spicedb gRPC API endpoint
1299-
--hostname-override string override the hostname used in the connection to the endpoint
1300-
--insecure connect over a plaintext connection
1301-
--log-format string format of logs ("auto", "console", "json") (default "auto")
1302-
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
1303-
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
1304-
--max-retries uint maximum number of sequential retries to attempt when a request fails (default 10)
1305-
--no-verify-ca do not attempt to verify the server's certificate chain and host name
1306-
--permissions-system string permissions system to query
1307-
--proxy string specify a SOCKS5 proxy address
1308-
--request-id string optional id to send along with SpiceDB requests for tracing
1309-
--skip-version-check if true, no version check is performed against the server
1310-
--token string token used to authenticate to SpiceDB
1311-
```
1312-
1313-
1314-
13151347
## Reference: `zed schema copy`
13161348

13171349
Copy a schema from one context into another

0 commit comments

Comments
 (0)