From 96a4ba08a542e61badeffc58455076cc76a651dc Mon Sep 17 00:00:00 2001 From: miparnisari <5374887+miparnisari@users.noreply.github.com> Date: Sat, 20 Dec 2025 00:39:28 +0000 Subject: [PATCH] [create-pull-request] automated change --- .../getting-started/installing-zed/page.mdx | 149 +++++++++++++----- 1 file changed, 110 insertions(+), 39 deletions(-) diff --git a/app/spicedb/getting-started/installing-zed/page.mdx b/app/spicedb/getting-started/installing-zed/page.mdx index 72d0a894..f3e00d02 100644 --- a/app/spicedb/getting-started/installing-zed/page.mdx +++ b/app/spicedb/getting-started/installing-zed/page.mdx @@ -1,4 +1,4 @@ -import { Callout } from "nextra/components"; +import { Callout } from 'nextra/components' # Installing Zed @@ -123,6 +123,7 @@ You can find more commands for tasks such as testing, linting in the repository' [CONTRIBUTING.md]: https://github.com/authzed/zed/blob/main/CONTRIBUTING.md + ## Reference: `zed` A command-line client for managing SpiceDB clusters. @@ -160,16 +161,17 @@ zed permission check --explain document:firstdoc writer user:emilia ### Children commands -- [zed backup](#reference-zed-backup) - Create, restore, and inspect permissions system backups -- [zed context](#reference-zed-context) - Manage configurations for connecting to SpiceDB deployments -- [zed import](#reference-zed-import) - Imports schema and relationships from a file or url -- [zed mcp](#reference-zed-mcp) - MCP (Model Context Protocol) server commands -- [zed permission](#reference-zed-permission) - Query the permissions in a permissions system -- [zed relationship](#reference-zed-relationship) - Query and mutate the relationships in a permissions system -- [zed schema](#reference-zed-schema) - Manage schema for a permissions system -- [zed use](#reference-zed-use) - Alias for `zed context use` -- [zed validate](#reference-zed-validate) - Validates the given validation file (.yaml, .zaml) or schema file (.zed) -- [zed version](#reference-zed-version) - Display zed and SpiceDB version information +- [zed backup](#reference-zed-backup) - Create, restore, and inspect permissions system backups +- [zed context](#reference-zed-context) - Manage configurations for connecting to SpiceDB deployments +- [zed import](#reference-zed-import) - Imports schema and relationships from a file or url +- [zed mcp](#reference-zed-mcp) - MCP (Model Context Protocol) server commands +- [zed permission](#reference-zed-permission) - Query the permissions in a permissions system +- [zed relationship](#reference-zed-relationship) - Query and mutate the relationships in a permissions system +- [zed schema](#reference-zed-schema) - Manage schema for a permissions system +- [zed use](#reference-zed-use) - Alias for `zed context use` +- [zed validate](#reference-zed-validate) - Validates the given validation file (.yaml, .zaml) or schema file (.zed) +- [zed version](#reference-zed-version) - Display zed and SpiceDB version information + ## Reference: `zed backup` @@ -208,12 +210,13 @@ zed backup [flags] ### Children commands -- [zed backup create](#reference-zed-backup-create) - Backup a permission system to a file -- [zed backup parse-relationships](#reference-zed-backup-parse-relationships) - Extract the relationships from a backup file -- [zed backup parse-revision](#reference-zed-backup-parse-revision) - Extract the revision from a backup file -- [zed backup parse-schema](#reference-zed-backup-parse-schema) - Extract the schema from a backup file -- [zed backup redact](#reference-zed-backup-redact) - Redact a backup file to remove sensitive information -- [zed backup restore](#reference-zed-backup-restore) - Restore a permission system from a file +- [zed backup create](#reference-zed-backup-create) - Backup a permission system to a file +- [zed backup parse-relationships](#reference-zed-backup-parse-relationships) - Extract the relationships from a backup file +- [zed backup parse-revision](#reference-zed-backup-parse-revision) - Extract the revision from a backup file +- [zed backup parse-schema](#reference-zed-backup-parse-schema) - Extract the schema from a backup file +- [zed backup redact](#reference-zed-backup-redact) - Redact a backup file to remove sensitive information +- [zed backup restore](#reference-zed-backup-restore) - Restore a permission system from a file + ## Reference: `zed backup create` @@ -250,6 +253,8 @@ zed backup create [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed backup parse-relationships` Extract the relationships from a backup file @@ -283,6 +288,8 @@ zed backup parse-relationships [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed backup parse-revision` Extract the revision from a backup file @@ -310,6 +317,8 @@ zed backup parse-revision --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed backup parse-schema` Extract the schema from a backup file @@ -344,6 +353,8 @@ zed backup parse-schema [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed backup redact` Redact a backup file to remove sensitive information @@ -380,6 +391,8 @@ zed backup redact [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed backup restore` Restore a permission system from a file @@ -419,6 +432,8 @@ zed backup restore [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed context` Manage configurations for connecting to SpiceDB deployments @@ -444,10 +459,11 @@ 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 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 +- [zed context list](#reference-zed-context-list) - Lists all available contexts +- [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 + ## Reference: `zed context list` @@ -482,6 +498,8 @@ zed context list [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed context remove` Removes a context by name @@ -509,6 +527,8 @@ zed context remove --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed context set` Creates or overwrite a context @@ -536,6 +556,8 @@ zed context set --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed context use` Sets a context as the current context @@ -563,6 +585,8 @@ zed context use --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed import` Imports schema and relationships from a file or url @@ -633,6 +657,8 @@ zed import [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed mcp` MCP (Model Context Protocol) server commands. @@ -662,7 +688,8 @@ To use with Claude Code, run `zed mcp experimental-run` to start the SpiceDB Dev ### Children commands -- [zed mcp experimental-run](#reference-zed-mcp-experimental-run) - Run the Experimental MCP server +- [zed mcp experimental-run](#reference-zed-mcp-experimental-run) - Run the Experimental MCP server + ## Reference: `zed mcp experimental-run` @@ -697,6 +724,8 @@ zed mcp experimental-run [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed permission` Query the permissions in a permissions system @@ -722,11 +751,12 @@ Query the permissions in a permissions system ### Children commands -- [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 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 +- [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 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` @@ -768,6 +798,8 @@ zed permission bulk [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed permission expand` Expand the structure of a permission @@ -847,6 +881,8 @@ zed permission expand [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed permission lookup-resources` Enumerates the resources of a given type for which a subject has permission @@ -889,6 +925,8 @@ zed permission lookup-resources [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed permission lookup-subjects` Enumerates the subjects of a given type for which the subject has permission on the resource @@ -928,6 +966,8 @@ zed permission lookup-subjects [flags] zed preview schema compile root.zed Write to an output file: zed preview schema compile root.zed --out compiled.zed - + ``` ### Options @@ -972,6 +1012,8 @@ zed preview schema compile [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed relationship` Query and mutate the relationships in a permissions system @@ -997,12 +1039,13 @@ Query and mutate the relationships in a permissions system ### Children commands -- [zed relationship bulk-delete](#reference-zed-relationship-bulk-delete) - Deletes relationships matching the provided pattern en masse -- [zed relationship create](#reference-zed-relationship-create) - Create a relationship for a subject -- [zed relationship delete](#reference-zed-relationship-delete) - Deletes a relationship -- [zed relationship read](#reference-zed-relationship-read) - Enumerates relationships matching the provided pattern -- [zed relationship touch](#reference-zed-relationship-touch) - Idempotently updates a relationship for a subject -- [zed relationship watch](#reference-zed-relationship-watch) - Watches the stream of relationship updates and schema updates from the server +- [zed relationship bulk-delete](#reference-zed-relationship-bulk-delete) - Deletes relationships matching the provided pattern en masse +- [zed relationship create](#reference-zed-relationship-create) - Create a relationship for a subject +- [zed relationship delete](#reference-zed-relationship-delete) - Deletes a relationship +- [zed relationship read](#reference-zed-relationship-read) - Enumerates relationships matching the provided pattern +- [zed relationship touch](#reference-zed-relationship-touch) - Idempotently updates a relationship for a subject +- [zed relationship watch](#reference-zed-relationship-watch) - Watches the stream of relationship updates and schema updates from the server + ## Reference: `zed relationship bulk-delete` @@ -1039,6 +1082,8 @@ zed relationship bulk-delete < --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed relationship touch` Idempotently updates a relationship for a subject @@ -1211,6 +1262,8 @@ zed relationship touch [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed schema diff` Diff two schema files @@ -1349,6 +1407,8 @@ zed schema diff --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed schema read` Read the schema of a permissions system @@ -1382,6 +1442,8 @@ zed schema read [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed schema write` Write a schema file (.zed or stdin) to the current permissions system @@ -1427,6 +1489,8 @@ zed schema write [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed use` Alias for `zed context use` @@ -1454,6 +1518,8 @@ zed use --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed validate` Validates the given validation file (.yaml, .zaml) or schema file (.zed) @@ -1512,6 +1578,8 @@ zed validate [flags] --token string token used to authenticate to SpiceDB ``` + + ## Reference: `zed version` Display zed and SpiceDB version information @@ -1545,3 +1613,6 @@ zed version [flags] --skip-version-check if true, no version check is performed against the server --token string token used to authenticate to SpiceDB ``` + + +