diff --git a/pages/spicedb/getting-started/installing-zed.mdx b/pages/spicedb/getting-started/installing-zed.mdx index 371c64b..940e9e0 100644 --- a/pages/spicedb/getting-started/installing-zed.mdx +++ b/pages/spicedb/getting-started/installing-zed.mdx @@ -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. @@ -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 @@ -1266,52 +1312,6 @@ Manage schema for a permissions system - [zed schema write](#reference-zed-schema-write) - Write a schema file (.zed or stdin) to the current permissions system -## Reference: `zed schema compile` - -Compile a schema that uses extended syntax into one that can be written to SpiceDB - -``` -zed schema compile [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