From c3e87bb24b1e827797111193e63ec620e115612e Mon Sep 17 00:00:00 2001 From: miparnisari <5374887+miparnisari@users.noreply.github.com> Date: Sat, 1 Nov 2025 02:28:21 +0000 Subject: [PATCH] [create-pull-request] automated change --- .../getting-started/installing-zed.mdx | 166 +++++++++++------- 1 file changed, 99 insertions(+), 67 deletions(-) diff --git a/pages/spicedb/getting-started/installing-zed.mdx b/pages/spicedb/getting-started/installing-zed.mdx index 371c64b..f3e00d0 100644 --- a/pages/spicedb/getting-started/installing-zed.mdx +++ b/pages/spicedb/getting-started/installing-zed.mdx @@ -460,7 +460,7 @@ Manage configurations for connecting to SpiceDB deployments ### Children commands - [zed context list](#reference-zed-context-list) - Lists all available contexts -- [zed context remove](#reference-zed-context-remove) - Removes a context +- [zed context remove](#reference-zed-context-remove) - Removes a context by name - [zed context set](#reference-zed-context-set) - Creates or overwrite a context - [zed context use](#reference-zed-context-use) - Sets a context as the current context @@ -502,10 +502,10 @@ zed context list [flags] ## Reference: `zed context remove` -Removes a context +Removes a context by name ``` -zed context remove +zed context remove ``` ### Options Inherited From Parent Flags @@ -563,7 +563,7 @@ zed context set Sets a context as the current context ``` -zed context use +zed context use ``` ### Options Inherited From Parent Flags @@ -662,7 +662,7 @@ zed import [flags] ## Reference: `zed mcp` MCP (Model Context Protocol) server commands. - + 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. 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 ### Children commands -- [zed permission bulk](#reference-zed-permission-bulk) - Check permissions in bulk exist for resource-subject pairs -- [zed permission check](#reference-zed-permission-check) - Check that a permission exists for a subject +- [zed permission bulk](#reference-zed-permission-bulk) - Check permissions in bulk exist for resource-permission-subject triplets +- [zed permission check](#reference-zed-permission-check) - Check if a subject has permission on a resource - [zed permission expand](#reference-zed-permission-expand) - Expand the structure of a permission -- [zed permission lookup-resources](#reference-zed-permission-lookup-resources) - Enumerates the resources of a given type for which the subject has permission +- [zed permission lookup-resources](#reference-zed-permission-lookup-resources) - Enumerates the resources of a given type for which a subject has permission - [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 ## Reference: `zed permission bulk` -Check permissions in bulk exist for resource-subject pairs +Check permissions in bulk exist for resource-permission-subject triplets ``` zed permission bulk ... [flags] @@ -802,7 +802,7 @@ zed permission bulk [flags] @@ -885,7 +885,7 @@ zed permission expand [flags] ## Reference: `zed permission lookup-resources` -Enumerates the resources of a given type for which the subject has permission +Enumerates the resources of a given type for which a subject has permission ``` zed permission lookup-resources [flags] @@ -968,6 +968,52 @@ zed permission lookup-subjects [flags] +``` + +### Examples + +``` + + Write to stdout: + zed preview schema compile root.zed + Write to an output file: + zed preview schema compile root.zed --out compiled.zed + +``` + +### Options + +``` + --out string output filepath; omitting writes to stdout +``` + +### Options Inherited From Parent Flags + +``` + --certificate-path string path to certificate authority used to verify secure connections + --endpoint string spicedb gRPC API endpoint + --hostname-override string override the hostname used in the connection to the endpoint + --insecure connect over a plaintext connection + --log-format string format of logs ("auto", "console", "json") (default "auto") + --log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info") + --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 + --max-retries uint maximum number of sequential retries to attempt when a request fails (default 10) + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --proxy string specify a SOCKS5 proxy address + --request-id string optional id to send along with SpiceDB requests for tracing + --skip-version-check if true, no version check is performed against the server + --token string token used to authenticate to SpiceDB +``` + + + ## Reference: `zed relationship` Query and mutate the relationships in a permissions system @@ -1046,6 +1092,15 @@ Create a relationship for a subject zed relationship create [flags] ``` +### Examples + +``` + + zed relationship create document:budget view user:anne --expiration-time "2025-12-31T23:59:59Z" + zed relationship create document:budget view user:anne --caveat ip_address:'{"ip": "192.168.0.1"} + +``` + ### Options ``` @@ -1114,15 +1169,19 @@ zed relationship delete [flags] +``` +### Examples ``` -zed relationship read [flags] + + # To filter returned relationships using a resource ID prefix, append a '%' to the resource ID. + zed relationship read document:finance-% + ``` ### Options @@ -1166,6 +1225,15 @@ Idempotently updates a relationship for a subject zed relationship touch [flags] ``` +### Examples + +``` + + zed relationship touch document:budget view user:anne --expiration-time "2025-12-31T23:59:59Z" + zed relationship touch document:budget view user:anne --caveat ip_address:'{"ip": "192.168.0.1"} + +``` + ### Options ``` @@ -1201,16 +1269,26 @@ zed relationship touch [flags] -``` - -### Examples - -``` - - Write to stdout: - zed preview schema compile root.zed - Write to an output file: - zed preview schema compile root.zed --out compiled.zed - -``` - -### Options - -``` - --out string output filepath; omitting writes to stdout -``` - -### Options Inherited From Parent Flags - -``` - --certificate-path string path to certificate authority used to verify secure connections - --endpoint string spicedb gRPC API endpoint - --hostname-override string override the hostname used in the connection to the endpoint - --insecure connect over a plaintext connection - --log-format string format of logs ("auto", "console", "json") (default "auto") - --log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info") - --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 - --max-retries uint maximum number of sequential retries to attempt when a request fails (default 10) - --no-verify-ca do not attempt to verify the server's certificate chain and host name - --permissions-system string permissions system to query - --proxy string specify a SOCKS5 proxy address - --request-id string optional id to send along with SpiceDB requests for tracing - --skip-version-check if true, no version check is performed against the server - --token string token used to authenticate to SpiceDB -``` - - - ## Reference: `zed schema copy` Copy a schema from one context into another