Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/authzed/zed
Official command-line tool for managing SpiceDB
https://github.com/authzed/zed
authorization authzed authzed-client command-line-tool database-management fine-grained-access-control fine-grained-authorization go golang permissions production sdk security security-tools spicedb spicedb-client zanzibar
Last synced: 1 day ago
JSON representation
Official command-line tool for managing SpiceDB
- Host: GitHub
- URL: https://github.com/authzed/zed
- Owner: authzed
- License: apache-2.0
- Created: 2021-04-12T08:00:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T17:59:27.000Z (10 days ago)
- Last Synced: 2024-10-26T02:16:45.837Z (9 days ago)
- Topics: authorization, authzed, authzed-client, command-line-tool, database-management, fine-grained-access-control, fine-grained-authorization, go, golang, permissions, production, sdk, security, security-tools, spicedb, spicedb-client, zanzibar
- Language: Go
- Homepage: https://authzed.com/docs/reference/clients
- Size: 1.45 MB
- Stars: 117
- Watchers: 7
- Forks: 25
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
- awesome-spicedb - zed - Official command-line tool for managing SpiceDB (Developer Tools / Official Tools)
README
# zed
[](https://authzed.com/docs)
[](https://www.youtube.com/channel/UCFeSgZf0rPqQteiTQNGgTPg)
[](https://authzed.com/discord)
[](https://twitter.com/authzed)
A command-line client for managing [SpiceDB].
[SpiceDB]: https://github.com/authzed/spicedb
zed features include:
- Context switching that stores credentials securely in your OS keychain
- Check, Expand, Lookup Resources, Lookup Subjects commands for Permissions
- Create, Read, Touch, Delete, Bulk-Delete commands for Relationships
- Read, Write, Validate, Import, Copy commands for Schemas
- Experimental Backup and Restore commands
Have questions? Ask in our [Discord].
Looking to contribute? See [CONTRIBUTING.md].
You can find issues by priority: [Urgent], [High], [Medium], [Low], [Maybe].
There are also [good first issues].
[Discord]: https://authzed.com/discord
[CONTRIBUTING.md]: https://github.com/authzed/spicedb/blob/main/CONTRIBUTING.md
[Urgent]: https://github.com/authzed/spicedb/labels/priority%2F0%20urgent
[High]: https://github.com/authzed/spicedb/labels/priority%2F1%20high
[Medium]: https://github.com/authzed/spicedb/labels/priority%2F2%20medium
[Low]: https://github.com/authzed/spicedb/labels/priority%2F3%20low
[Maybe]: https://github.com/authzed/spicedb/labels/priority%2F4%20maybe
[good first issues]: https://github.com/authzed/spicedb/labels/hint%2Fgood%20first%20issue
## Getting Started
### Installing the binary
Binary releases are available for Linux, macOS, and Windows on AMD64 and ARM64 architectures.
[Homebrew] users for both macOS and Linux can install the latest binary releases of zed using the official tap:
```command
brew install authzed/tap/zed
```
[Debian-based Linux] users can install zed packages by adding a new APT source:
```command
sudo apt update && sudo apt install -y curl ca-certificates gpg
curl https://apt.fury.io/authzed/gpg.key | sudo apt-key add -
sudo sh -c 'echo "deb https://apt.fury.io/authzed/ * *" > /etc/apt/sources.list.d/fury.list'
sudo apt update && sudo apt install -y zed
```
[RPM-based Linux] users can install zed packages by adding a new YUM repository:
```command
sudo cat << EOF >> /etc/yum.repos.d/Authzed-Fury.repo
[authzed-fury]
name=AuthZed Fury Repository
baseurl=https://yum.fury.io/authzed/
enabled=1
gpgcheck=0
EOF
sudo dnf install -y zed
```
[homebrew]: https://docs.authzed.com/spicedb/installing#brew
[Debian-based Linux]: https://en.wikipedia.org/wiki/List_of_Linux_distributions#Debian-based
[RPM-based Linux]: https://en.wikipedia.org/wiki/List_of_Linux_distributions#RPM-based
### Creating a context
Contexts store connection credentials for accessing SpiceDB clusters securely in the OS keychain.
Before performing most commands, a context must be set.
The `zed context` subcommand has operations for setting the current, creating, listing, deleting contexts:
```sh
zed context set prod grpc.authzed.com:443 tc_zed_my_laptop_deadbeefdeadbeefdeadbeefdeadbeef
zed context set dev localhost:80 testpresharedkey --insecure
zed context list
```
### Overriding Context
You can also provide context values via environment variables or CLI flags. If values are provided this way, they override
the context values in a piecemeal fashion:
```sh
zed context set prod grpc.authzed.com:443 tc_zed_my_laptop_deadbeefdeadbeefdeadbeefdeadbeef
# This will use the token and TLS values set above, but swap out the endpoint for the one provided.
zed permission check --endpoint my.authzed.domain:443 document:firstdoc writer user:emilia
```
### Headless usage
If you provide all context values (e.g. `ZED_ENDPOINT`, `ZED_TOKEN`) as environment variables or flags (e.g. `--endpoint`, `--token`), you do not need to set a context.
You can also provide the `ZED_KEYRING_PASSWORD` environment variable to access an existing context in a non-interactive way.
```sh
zed schema read --endpoint grpc.authzed.com:443 --token tc_zed_my_laptop_deadbeefdeadbeef
ZED_ENDPOINT=grpc.authzed.com:443 ZED_TOKEN=tc_zed_my_laptop_deadbeefdeadbeef zed schema read
ZED_KEYRING_PASSWORD=redacted zed schema read
```
### Debugging
The `--explain` flag can be used on `permission check` to see a trace:
```sh
zed permission check document:firstdoc writer user:emilia --explain
```
## Acknowledgements
zed is a community project fueled by contributions from both organizations and individuals.
We appreciate all contributions, large and small, and would like to thank all those involved.
In addition, we'd like to highlight a few notable contributions:
- The GitHub Authorization Team for implementing the bulk-delete command