Skip to content

Commit 480eddb

Browse files
josephschorrgithub-actions[bot]
authored andcommitted
[create-pull-request] automated change
1 parent 61d40e8 commit 480eddb

File tree

1 file changed

+86
-52
lines changed

1 file changed

+86
-52
lines changed

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

Lines changed: 86 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
import { Callout } from 'nextra/components'
1+
# zed
22

3-
# Installing Zed
3+
## Getting Started
44

5-
[Zed](https://github.com/authzed/zed) is the CLI used to interact with SpiceDB.
5+
### Installing the binary
66

7-
It is built as a standalone executable file which simplifies installation, but one should prefer one of the recommended installation methods detailed below.
7+
Binary releases are available for Linux, macOS, and Windows on AMD64 and ARM64 architectures.
88

9-
## Debian packages
9+
[Homebrew] users for both macOS and Linux can install the latest binary releases of zed using the official tap:
1010

11-
[Debian-based Linux] users can install SpiceDB packages by adding an additional apt source.
11+
```sh
12+
brew install authzed/tap/zed
13+
```
14+
15+
[Debian-based Linux] users can install zed packages by adding a new APT source:
1216

1317
First, download the public signing key for the repository:
1418

@@ -24,11 +28,12 @@ Then add the list file for the repository:
2428
```sh
2529
echo "deb [signed-by=/etc/apt/keyrings/authzed.gpg] https://pkg.authzed.com/apt/ * *" | sudo tee /etc/apt/sources.list.d/authzed.list
2630
sudo chmod 644 /etc/apt/sources.list.d/authzed.list # helps tools such as command-not-found to work correctly
31+
2732
```
2833

2934
Alternatively, if you want to use the new `deb822`-style `authzed.sources` format, put the following in `/etc/apt/sources.list.d/authzed.sources`:
3035

31-
```
36+
```yaml
3237
Types: deb
3338
URIs: https://pkg.authzed.com/apt/
3439
Suites: *
@@ -43,40 +48,23 @@ sudo apt update
4348
sudo apt install -y zed
4449
```
4550

46-
[Debian-based Linux]: https://en.wikipedia.org/wiki/List_of_Linux_distributions#Debian-based
47-
48-
## RPM packages
49-
50-
[RPM-based Linux] users can install packages by adding a new yum repository:
51+
[RPM-based Linux] users can install zed packages by adding a new YUM repository:
5152

5253
```sh
5354
sudo cat << EOF >> /etc/yum.repos.d/Authzed-Fury.repo
5455
[authzed-fury]
5556
name=AuthZed Fury Repository
56-
baseurl=https://pkg.authzed.com/yum/
57+
baseurl=https://yum.fury.io/authzed/
5758
enabled=1
5859
gpgcheck=0
5960
EOF
60-
```
61-
62-
Install as usual:
63-
64-
```sh
6561
sudo dnf install -y zed
6662
```
6763

64+
[homebrew]: https://docs.authzed.com/spicedb/installing#brew
65+
[Debian-based Linux]: https://en.wikipedia.org/wiki/List_of_Linux_distributions#Debian-based
6866
[RPM-based Linux]: https://en.wikipedia.org/wiki/List_of_Linux_distributions#RPM-based
6967

70-
## Homebrew (macOS)
71-
72-
macOS users can install packages by adding a [Homebrew tap]:
73-
74-
```sh
75-
brew install authzed/tap/zed
76-
```
77-
78-
[Homebrew tap]: https://docs.brew.sh/Taps
79-
8068
### Other methods
8169

8270
#### Docker
@@ -93,35 +81,12 @@ You can pull down the latest stable release:
9381
docker pull authzed/zed
9482
```
9583

96-
Afterwards, you can run it with `docker run`:
84+
Afterward, you can run it with `docker run`:
9785

9886
```sh
9987
docker run --rm authzed/zed version
10088
```
10189

102-
#### Downloading the binary
103-
104-
Visit the GitHub release page for the [latest release](https://github.com/authzed/zed/releases/latest).
105-
Scroll down to the `Assets` section and download the appropriate artifact.
106-
107-
#### Source
108-
109-
Clone the GitHub repository:
110-
111-
```sh
112-
git clone [email protected]:authzed/zed.git
113-
```
114-
115-
Enter the directory and build the binary using mage:
116-
117-
```sh
118-
cd zed
119-
go build ./cmd/zed
120-
```
121-
122-
You can find more commands for tasks such as testing, linting in the repository's [CONTRIBUTING.md].
123-
124-
[CONTRIBUTING.md]: https://github.com/authzed/zed/blob/main/CONTRIBUTING.md
12590

12691
## Reference: `zed`
12792

@@ -163,6 +128,7 @@ zed permission check --explain document:firstdoc writer user:emilia
163128
- [zed backup](#reference-zed-backup) - Create, restore, and inspect permissions system backups
164129
- [zed context](#reference-zed-context) - Manage configurations for connecting to SpiceDB deployments
165130
- [zed import](#reference-zed-import) - Imports schema and relationships from a file or url
131+
- [zed mcp](#reference-zed-mcp) - MCP (Model Context Protocol) server commands
166132
- [zed permission](#reference-zed-permission) - Query the permissions in a permissions system
167133
- [zed relationship](#reference-zed-relationship) - Query and mutate the relationships in a permissions system
168134
- [zed schema](#reference-zed-schema) - Manage schema for a permissions system
@@ -657,6 +623,74 @@ zed import <url> [flags]
657623

658624

659625

626+
## Reference: `zed mcp`
627+
628+
MCP (Model Context Protocol) server commands.
629+
630+
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.
631+
632+
To use with Claude Code, run "zed mcp 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.
633+
634+
635+
### Options Inherited From Parent Flags
636+
637+
```
638+
--certificate-path string path to certificate authority used to verify secure connections
639+
--endpoint string spicedb gRPC API endpoint
640+
--hostname-override string override the hostname used in the connection to the endpoint
641+
--insecure connect over a plaintext connection
642+
--log-format string format of logs ("auto", "console", "json") (default "auto")
643+
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
644+
--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
645+
--max-retries uint maximum number of sequential retries to attempt when a request fails (default 10)
646+
--no-verify-ca do not attempt to verify the server's certificate chain and host name
647+
--permissions-system string permissions system to query
648+
--proxy string specify a SOCKS5 proxy address
649+
--request-id string optional id to send along with SpiceDB requests for tracing
650+
--skip-version-check if true, no version check is performed against the server
651+
--token string token used to authenticate to SpiceDB
652+
```
653+
654+
### Children commands
655+
656+
- [zed mcp run](#reference-zed-mcp-run) - Run the MCP server
657+
658+
659+
## Reference: `zed mcp run`
660+
661+
Run the MCP server
662+
663+
```
664+
zed mcp run [flags]
665+
```
666+
667+
### Options
668+
669+
```
670+
-p, --port int port for the HTTP streaming server (default 9999)
671+
```
672+
673+
### Options Inherited From Parent Flags
674+
675+
```
676+
--certificate-path string path to certificate authority used to verify secure connections
677+
--endpoint string spicedb gRPC API endpoint
678+
--hostname-override string override the hostname used in the connection to the endpoint
679+
--insecure connect over a plaintext connection
680+
--log-format string format of logs ("auto", "console", "json") (default "auto")
681+
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
682+
--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
683+
--max-retries uint maximum number of sequential retries to attempt when a request fails (default 10)
684+
--no-verify-ca do not attempt to verify the server's certificate chain and host name
685+
--permissions-system string permissions system to query
686+
--proxy string specify a SOCKS5 proxy address
687+
--request-id string optional id to send along with SpiceDB requests for tracing
688+
--skip-version-check if true, no version check is performed against the server
689+
--token string token used to authenticate to SpiceDB
690+
```
691+
692+
693+
660694
## Reference: `zed permission`
661695

662696
Query the permissions in a permissions system

0 commit comments

Comments
 (0)