Skip to content

Auto-generated PR: Update zed docs #399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Auto-generated PR: Update zed docs #399

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
166 changes: 99 additions & 67 deletions pages/spicedb/getting-started/installing-zed.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -502,10 +502,10 @@ zed context list [flags]

## Reference: `zed context remove`

Removes a context
Removes a context by name

```
zed context remove <system>
zed context remove <name>
```

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

```
zed context use <system>
zed context use <name>
```

### Options Inherited From Parent Flags
Expand Down Expand Up @@ -662,7 +662,7 @@ zed import <url> [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.
Expand Down Expand Up @@ -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 <resource:id#permission@subject:id> <resource:id#permission@subject:id> ... [flags]
Expand Down Expand Up @@ -802,7 +802,7 @@ zed permission bulk <resource:id#permission@subject:id> <resource:id#permission@

## Reference: `zed permission check`

Check that a permission exists for a subject
Check if a subject has permission on a resource

```
zed permission check <resource:id> <permission> <subject:id> [flags]
Expand Down Expand Up @@ -885,7 +885,7 @@ zed permission expand <permission> <resource:id> [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 <type> <permission> <subject:id> [flags]
Expand Down Expand Up @@ -968,6 +968,52 @@ zed permission lookup-subjects <resource:id> <permission> <subject_type#optional



## Reference: `zed preview schema compile`

Compile a schema that uses extended syntax into one that can be written to SpiceDB

```
zed preview schema compile <file> [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
Expand Down Expand Up @@ -1046,6 +1092,15 @@ Create a relationship for a subject
zed relationship create <resource:id> <relation> <subject:id#optional_subject_relation> [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

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

## Reference: `zed relationship read`

Enumerates relationships matching the provided pattern.
Enumerates relationships matching the provided pattern

To filter returned relationships using a resource ID prefix, append a '%' to the resource ID:

zed relationship read some-type:some-prefix-%
```
zed relationship read <resource_type:optional_resource_id> <optional_relation> <optional_subject_type:optional_subject_id#optional_subject_relation> [flags]
```

### Examples

```
zed relationship read <resource_type:optional_resource_id> <optional_relation> <optional_subject_type:optional_subject_id#optional_subject_relation> [flags]

# To filter returned relationships using a resource ID prefix, append a '%' to the resource ID.
zed relationship read document:finance-%

```

### Options
Expand Down Expand Up @@ -1166,6 +1225,15 @@ Idempotently updates a relationship for a subject
zed relationship touch <resource:id> <relation> <subject:id#optional_subject_relation> [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

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

```
zed relationship watch [object_types, ...] [start_cursor] [flags]
zed relationship watch [object_types, ...] [revision] [flags]
```

### Examples

```

zed relationship watch --filter document:finance
zed relationship watch --filter document:finance#view
zed relationship watch --filter document:finance#view@user:anne

```

### Options

```
--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
--object_types strings optional object types to watch updates for
--revision string optional revision at which to start watching
--timestamp shows timestamp of incoming update events
--filter strings optional filter(s) for the watch stream
--object_types strings optional object types to watch updates for
--revision string optional revision at which to start watching
--timestamp shows timestamp of incoming update events
```

### Options Inherited From Parent Flags
Expand Down Expand Up @@ -1266,52 +1344,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 <file> [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
Expand Down
Loading