From 137812f8557eab68876f41b221a86282c878e6dc Mon Sep 17 00:00:00 2001 From: Kartikay Date: Fri, 17 Jan 2025 18:36:13 +0530 Subject: [PATCH] added zed docs Signed-off-by: Kartikay --- pages/_meta.json | 4 ++ pages/index.mdx | 5 +- pages/zed/zed.md | 39 +++++++++++ pages/zed/zed_backup.md | 44 ++++++++++++ pages/zed/zed_backup_create.md | 38 ++++++++++ pages/zed/zed_backup_parse-relationships.md | 37 ++++++++++ pages/zed/zed_backup_parse-revision.md | 36 ++++++++++ pages/zed/zed_backup_parse-schema.md | 38 ++++++++++ pages/zed/zed_backup_redact.md | 40 +++++++++++ pages/zed/zed_backup_restore.md | 43 ++++++++++++ pages/zed/zed_context.md | 36 ++++++++++ pages/zed/zed_context_list.md | 37 ++++++++++ pages/zed/zed_context_remove.md | 36 ++++++++++ pages/zed/zed_context_set.md | 36 ++++++++++ pages/zed/zed_context_use.md | 36 ++++++++++ pages/zed/zed_import.md | 74 ++++++++++++++++++++ pages/zed/zed_permission.md | 37 ++++++++++ pages/zed/zed_permission_bulk.md | 44 ++++++++++++ pages/zed/zed_permission_check.md | 45 ++++++++++++ pages/zed/zed_permission_expand.md | 42 +++++++++++ pages/zed/zed_permission_lookup-resources.md | 44 ++++++++++++ pages/zed/zed_permission_lookup-subjects.md | 43 ++++++++++++ pages/zed/zed_relationship.md | 38 ++++++++++ pages/zed/zed_relationship_bulk-delete.md | 39 +++++++++++ pages/zed/zed_relationship_create.md | 39 +++++++++++ pages/zed/zed_relationship_delete.md | 38 ++++++++++ pages/zed/zed_relationship_read.md | 52 ++++++++++++++ pages/zed/zed_relationship_touch.md | 39 +++++++++++ pages/zed/zed_relationship_watch.md | 40 +++++++++++ pages/zed/zed_schema.md | 36 ++++++++++ pages/zed/zed_schema_copy.md | 38 ++++++++++ pages/zed/zed_schema_diff.md | 36 ++++++++++ pages/zed/zed_schema_read.md | 37 ++++++++++ pages/zed/zed_schema_write.md | 38 ++++++++++ pages/zed/zed_use.md | 36 ++++++++++ pages/zed/zed_validate.md | 60 ++++++++++++++++ pages/zed/zed_version.md | 38 ++++++++++ 37 files changed, 1437 insertions(+), 1 deletion(-) create mode 100644 pages/zed/zed.md create mode 100644 pages/zed/zed_backup.md create mode 100644 pages/zed/zed_backup_create.md create mode 100644 pages/zed/zed_backup_parse-relationships.md create mode 100644 pages/zed/zed_backup_parse-revision.md create mode 100644 pages/zed/zed_backup_parse-schema.md create mode 100644 pages/zed/zed_backup_redact.md create mode 100644 pages/zed/zed_backup_restore.md create mode 100644 pages/zed/zed_context.md create mode 100644 pages/zed/zed_context_list.md create mode 100644 pages/zed/zed_context_remove.md create mode 100644 pages/zed/zed_context_set.md create mode 100644 pages/zed/zed_context_use.md create mode 100644 pages/zed/zed_import.md create mode 100644 pages/zed/zed_permission.md create mode 100644 pages/zed/zed_permission_bulk.md create mode 100644 pages/zed/zed_permission_check.md create mode 100644 pages/zed/zed_permission_expand.md create mode 100644 pages/zed/zed_permission_lookup-resources.md create mode 100644 pages/zed/zed_permission_lookup-subjects.md create mode 100644 pages/zed/zed_relationship.md create mode 100644 pages/zed/zed_relationship_bulk-delete.md create mode 100644 pages/zed/zed_relationship_create.md create mode 100644 pages/zed/zed_relationship_delete.md create mode 100644 pages/zed/zed_relationship_read.md create mode 100644 pages/zed/zed_relationship_touch.md create mode 100644 pages/zed/zed_relationship_watch.md create mode 100644 pages/zed/zed_schema.md create mode 100644 pages/zed/zed_schema_copy.md create mode 100644 pages/zed/zed_schema_diff.md create mode 100644 pages/zed/zed_schema_read.md create mode 100644 pages/zed/zed_schema_write.md create mode 100644 pages/zed/zed_use.md create mode 100644 pages/zed/zed_validate.md create mode 100644 pages/zed/zed_version.md diff --git a/pages/_meta.json b/pages/_meta.json index b5a72cb0..6fa5593a 100644 --- a/pages/_meta.json +++ b/pages/_meta.json @@ -10,5 +10,9 @@ "authzed": { "title": "AuthZed Product Documentation", "type": "page" + }, + "zed": { + "title": "Zed Documentation", + "type": "page" } } diff --git a/pages/index.mdx b/pages/index.mdx index ab1857d1..d0de253c 100644 --- a/pages/index.mdx +++ b/pages/index.mdx @@ -1,6 +1,6 @@ # -Browse documentation for **SpiceDB** or **AuthZed Products** by selecting one below. +Browse documentation for **SpiceDB**, **AuthZed Products** or **Zed** by selecting one below. import { Cards } from 'nextra/components' @@ -16,4 +16,7 @@ import { Cards } from 'nextra/components'

AuthZed Products Documentation

 + +

Zed Documentation

+ diff --git a/pages/zed/zed.md b/pages/zed/zed.md new file mode 100644 index 00000000..ea094293 --- /dev/null +++ b/pages/zed/zed.md @@ -0,0 +1,39 @@ +## zed + +SpiceDB client, by AuthZed + +### Synopsis + +A command-line client for managing SpiceDB clusters, built by AuthZed + +### Options + +``` + --certificate-path string path to certificate authority used to verify secure connections + --endpoint string spicedb gRPC API endpoint + -h, --help help for zed + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups +* [zed context](zed_context.md) - Manage configurations for connecting to SpiceDB deployments +* [zed import](zed_import.md) - Imports schema and relationships from a file or url +* [zed permission](zed_permission.md) - Query the permissions in a permissions system +* [zed relationship](zed_relationship.md) - Query and mutate the relationships in a permissions system +* [zed schema](zed_schema.md) - Manage schema for a permissions system +* [zed use](zed_use.md) - Alias for `zed context use` +* [zed validate](zed_validate.md) - Validates the given validation file (.yaml, .zaml) or schema file (.zed) +* [zed version](zed_version.md) - Display zed and SpiceDB version information + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_backup.md b/pages/zed/zed_backup.md new file mode 100644 index 00000000..5c8e995f --- /dev/null +++ b/pages/zed/zed_backup.md @@ -0,0 +1,44 @@ +## zed backup + +Create, restore, and inspect permissions system backups + +``` +zed backup [flags] +``` + +### Options + +``` + -h, --help help for backup + --prefix-filter string include only schema and relationships with a given prefix + --rewrite-legacy potentially modify the schema to exclude legacy/broken syntax +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed](zed.md) - SpiceDB client, by AuthZed +* [zed backup create](zed_backup_create.md) - Backup a permission system to a file +* [zed backup parse-relationships](zed_backup_parse-relationships.md) - Extract the relationships from a backup file +* [zed backup parse-revision](zed_backup_parse-revision.md) - Extract the revision from a backup file +* [zed backup parse-schema](zed_backup_parse-schema.md) - Extract the schema from a backup file +* [zed backup redact](zed_backup_redact.md) - Redact a backup file to remove sensitive information +* [zed backup restore](zed_backup_restore.md) - Restore a permission system from a file + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_backup_create.md b/pages/zed/zed_backup_create.md new file mode 100644 index 00000000..6a421cc4 --- /dev/null +++ b/pages/zed/zed_backup_create.md @@ -0,0 +1,38 @@ +## zed backup create + +Backup a permission system to a file + +``` +zed backup create [flags] +``` + +### Options + +``` + -h, --help help for create + --prefix-filter string include only schema and relationships with a given prefix + --rewrite-legacy potentially modify the schema to exclude legacy/broken syntax +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_backup_parse-relationships.md b/pages/zed/zed_backup_parse-relationships.md new file mode 100644 index 00000000..4e07907f --- /dev/null +++ b/pages/zed/zed_backup_parse-relationships.md @@ -0,0 +1,37 @@ +## zed backup parse-relationships + +Extract the relationships from a backup file + +``` +zed backup parse-relationships [flags] +``` + +### Options + +``` + -h, --help help for parse-relationships + --prefix-filter string Include only relationships with a given prefix +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_backup_parse-revision.md b/pages/zed/zed_backup_parse-revision.md new file mode 100644 index 00000000..85505e34 --- /dev/null +++ b/pages/zed/zed_backup_parse-revision.md @@ -0,0 +1,36 @@ +## zed backup parse-revision + +Extract the revision from a backup file + +``` +zed backup parse-revision [flags] +``` + +### Options + +``` + -h, --help help for parse-revision +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_backup_parse-schema.md b/pages/zed/zed_backup_parse-schema.md new file mode 100644 index 00000000..dff115bf --- /dev/null +++ b/pages/zed/zed_backup_parse-schema.md @@ -0,0 +1,38 @@ +## zed backup parse-schema + +Extract the schema from a backup file + +``` +zed backup parse-schema [flags] +``` + +### Options + +``` + -h, --help help for parse-schema + --prefix-filter string include only schema and relationships with a given prefix + --rewrite-legacy potentially modify the schema to exclude legacy/broken syntax +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_backup_redact.md b/pages/zed/zed_backup_redact.md new file mode 100644 index 00000000..a7541e6e --- /dev/null +++ b/pages/zed/zed_backup_redact.md @@ -0,0 +1,40 @@ +## zed backup redact + +Redact a backup file to remove sensitive information + +``` +zed backup redact [flags] +``` + +### Options + +``` + -h, --help help for redact + --print-redacted-object-ids prints the redacted object IDs + --redact-definitions redact definitions (default true) + --redact-object-ids redact object IDs (default true) + --redact-relations redact relations (default true) +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_backup_restore.md b/pages/zed/zed_backup_restore.md new file mode 100644 index 00000000..01591447 --- /dev/null +++ b/pages/zed/zed_backup_restore.md @@ -0,0 +1,43 @@ +## zed backup restore + +Restore a permission system from a file + +``` +zed backup restore [flags] +``` + +### Options + +``` + --batch-size uint restore relationship write batch size (default 1000) + --batches-per-transaction uint number of batches per transaction (default 10) + --conflict-strategy string strategy used when a conflicting relationship is found. Possible values: fail, skip, touch (default "fail") + --disable-retries retries when an errors is determined to be retryable (e.g. serialization errors) + -h, --help help for restore + --prefix-filter string include only schema and relationships with a given prefix + --request-timeout duration timeout for each request performed during restore (default 30s) + --rewrite-legacy potentially modify the schema to exclude legacy/broken syntax +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_context.md b/pages/zed/zed_context.md new file mode 100644 index 00000000..20a15820 --- /dev/null +++ b/pages/zed/zed_context.md @@ -0,0 +1,36 @@ +## zed context + +Manage configurations for connecting to SpiceDB deployments + +### Options + +``` + -h, --help help for context +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed](zed.md) - SpiceDB client, by AuthZed +* [zed context list](zed_context_list.md) - Lists all available contexts +* [zed context remove](zed_context_remove.md) - Removes a context +* [zed context set](zed_context_set.md) - Creates or overwrite a context +* [zed context use](zed_context_use.md) - Sets a context as the current context + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_context_list.md b/pages/zed/zed_context_list.md new file mode 100644 index 00000000..6832ad37 --- /dev/null +++ b/pages/zed/zed_context_list.md @@ -0,0 +1,37 @@ +## zed context list + +Lists all available contexts + +``` +zed context list [flags] +``` + +### Options + +``` + -h, --help help for list + --reveal-tokens display secrets in results +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed context](zed_context.md) - Manage configurations for connecting to SpiceDB deployments + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_context_remove.md b/pages/zed/zed_context_remove.md new file mode 100644 index 00000000..771278a3 --- /dev/null +++ b/pages/zed/zed_context_remove.md @@ -0,0 +1,36 @@ +## zed context remove + +Removes a context + +``` +zed context remove [flags] +``` + +### Options + +``` + -h, --help help for remove +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed context](zed_context.md) - Manage configurations for connecting to SpiceDB deployments + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_context_set.md b/pages/zed/zed_context_set.md new file mode 100644 index 00000000..f3a45852 --- /dev/null +++ b/pages/zed/zed_context_set.md @@ -0,0 +1,36 @@ +## zed context set + +Creates or overwrite a context + +``` +zed context set [flags] +``` + +### Options + +``` + -h, --help help for set +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed context](zed_context.md) - Manage configurations for connecting to SpiceDB deployments + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_context_use.md b/pages/zed/zed_context_use.md new file mode 100644 index 00000000..750295e7 --- /dev/null +++ b/pages/zed/zed_context_use.md @@ -0,0 +1,36 @@ +## zed context use + +Sets a context as the current context + +``` +zed context use [flags] +``` + +### Options + +``` + -h, --help help for use +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed context](zed_context.md) - Manage configurations for connecting to SpiceDB deployments + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_import.md b/pages/zed/zed_import.md new file mode 100644 index 00000000..d1b0944d --- /dev/null +++ b/pages/zed/zed_import.md @@ -0,0 +1,74 @@ +## zed import + +Imports schema and relationships from a file or url + +``` +zed import [flags] +``` + +### Examples + +``` + + From a gist: + zed import https://gist.github.com/ecordell/8e3b613a677e3c844742cf24421c08b6 + + From a playground link: + zed import https://play.authzed.com/s/iksdFvCtvnkR/schema + + From pastebin: + zed import https://pastebin.com/8qU45rVK + + From a devtools instance: + zed import https://localhost:8443/download + + From a local file (with prefix): + zed import file:///Users/zed/Downloads/authzed-x7izWU8_2Gw3.yaml + + From a local file (no prefix): + zed import authzed-x7izWU8_2Gw3.yaml + + Only schema: + zed import --relationships=false file:///Users/zed/Downloads/authzed-x7izWU8_2Gw3.yaml + + Only relationships: + zed import --schema=false file:///Users/zed/Downloads/authzed-x7izWU8_2Gw3.yaml + + With schema definition prefix: + zed import --schema-definition-prefix=mypermsystem file:///Users/zed/Downloads/authzed-x7izWU8_2Gw3.yaml + +``` + +### Options + +``` + --batch-size int import batch size (default 1000) + -h, --help help for import + --relationships import relationships (default true) + --schema import schema (default true) + --schema-definition-prefix string prefix to add to the schema's definition(s) before importing + --workers int number of concurrent batching workers (default 1) +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed](zed.md) - SpiceDB client, by AuthZed + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_permission.md b/pages/zed/zed_permission.md new file mode 100644 index 00000000..3eb28dc5 --- /dev/null +++ b/pages/zed/zed_permission.md @@ -0,0 +1,37 @@ +## zed permission + +Query the permissions in a permissions system + +### Options + +``` + -h, --help help for permission +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed](zed.md) - SpiceDB client, by AuthZed +* [zed permission bulk](zed_permission_bulk.md) - Check a permissions in bulk exists for a resource-subject pairs +* [zed permission check](zed_permission_check.md) - Check that a permission exists for a subject +* [zed permission expand](zed_permission_expand.md) - Expand the structure of a permission +* [zed permission lookup-resources](zed_permission_lookup-resources.md) - Enumerates resources of a given type for which the subject has permission +* [zed permission lookup-subjects](zed_permission_lookup-subjects.md) - Enumerates the subjects of a given type for which the subject has permission on the resource + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_permission_bulk.md b/pages/zed/zed_permission_bulk.md new file mode 100644 index 00000000..a9d9bc0f --- /dev/null +++ b/pages/zed/zed_permission_bulk.md @@ -0,0 +1,44 @@ +## zed permission bulk + +Check a permissions in bulk exists for a resource-subject pairs + +``` +zed permission bulk ... [flags] +``` + +### Options + +``` + --consistency-at-exactly string evaluate at the provided zedtoken + --consistency-at-least string evaluate at least as consistent as the provided zedtoken + --consistency-full evaluate at the newest zedtoken in the database + --consistency-min-latency evaluate at the zedtoken preferred by the database + --explain requests debug information from SpiceDB and prints out a trace of the requests + -h, --help help for bulk + --json output as JSON + --revision string optional revision at which to check + --schema requests debug information from SpiceDB and prints out the schema used +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed permission](zed_permission.md) - Query the permissions in a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_permission_check.md b/pages/zed/zed_permission_check.md new file mode 100644 index 00000000..0cb0a7f2 --- /dev/null +++ b/pages/zed/zed_permission_check.md @@ -0,0 +1,45 @@ +## zed permission check + +Check that a permission exists for a subject + +``` +zed permission check [flags] +``` + +### Options + +``` + --caveat-context string the caveat context to send along with the check, in JSON form + --consistency-at-exactly string evaluate at the provided zedtoken + --consistency-at-least string evaluate at least as consistent as the provided zedtoken + --consistency-full evaluate at the newest zedtoken in the database + --consistency-min-latency evaluate at the zedtoken preferred by the database + --error-on-no-permission if true, zed will return exit code 1 if subject does not have unconditional permission + --explain requests debug information from SpiceDB and prints out a trace of the requests + -h, --help help for check + --json output as JSON + --schema requests debug information from SpiceDB and prints out the schema used +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed permission](zed_permission.md) - Query the permissions in a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_permission_expand.md b/pages/zed/zed_permission_expand.md new file mode 100644 index 00000000..08d43af7 --- /dev/null +++ b/pages/zed/zed_permission_expand.md @@ -0,0 +1,42 @@ +## zed permission expand + +Expand the structure of a permission + +``` +zed permission expand [flags] +``` + +### Options + +``` + --consistency-at-exactly string evaluate at the provided zedtoken + --consistency-at-least string evaluate at least as consistent as the provided zedtoken + --consistency-full evaluate at the newest zedtoken in the database + --consistency-min-latency evaluate at the zedtoken preferred by the database + -h, --help help for expand + --json output as JSON + --revision string optional revision at which to check +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed permission](zed_permission.md) - Query the permissions in a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_permission_lookup-resources.md b/pages/zed/zed_permission_lookup-resources.md new file mode 100644 index 00000000..ab95d353 --- /dev/null +++ b/pages/zed/zed_permission_lookup-resources.md @@ -0,0 +1,44 @@ +## zed permission lookup-resources + +Enumerates resources of a given type for which the subject has permission + +``` +zed permission lookup-resources [flags] +``` + +### Options + +``` + --caveat-context string the caveat context to send along with the lookup, in JSON form + --consistency-at-exactly string evaluate at the provided zedtoken + --consistency-at-least string evaluate at least as consistent as the provided zedtoken + --consistency-full evaluate at the newest zedtoken in the database + --consistency-min-latency evaluate at the zedtoken preferred by the database + -h, --help help for lookup-resources + --json output as JSON + --page-limit uint32 limit of relations returned per page + --revision string optional revision at which to check +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed permission](zed_permission.md) - Query the permissions in a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_permission_lookup-subjects.md b/pages/zed/zed_permission_lookup-subjects.md new file mode 100644 index 00000000..b73907b9 --- /dev/null +++ b/pages/zed/zed_permission_lookup-subjects.md @@ -0,0 +1,43 @@ +## zed permission lookup-subjects + +Enumerates the subjects of a given type for which the subject has permission on the resource + +``` +zed permission lookup-subjects [flags] +``` + +### Options + +``` + --caveat-context string the caveat context to send along with the lookup, in JSON form + --consistency-at-exactly string evaluate at the provided zedtoken + --consistency-at-least string evaluate at least as consistent as the provided zedtoken + --consistency-full evaluate at the newest zedtoken in the database + --consistency-min-latency evaluate at the zedtoken preferred by the database + -h, --help help for lookup-subjects + --json output as JSON + --revision string optional revision at which to check +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed permission](zed_permission.md) - Query the permissions in a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_relationship.md b/pages/zed/zed_relationship.md new file mode 100644 index 00000000..55b4efc9 --- /dev/null +++ b/pages/zed/zed_relationship.md @@ -0,0 +1,38 @@ +## zed relationship + +Query and mutate the relationships in a permissions system + +### Options + +``` + -h, --help help for relationship +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed](zed.md) - SpiceDB client, by AuthZed +* [zed relationship bulk-delete](zed_relationship_bulk-delete.md) - Deletes relationships matching the provided pattern en masse +* [zed relationship create](zed_relationship_create.md) - Create a relationship for a subject +* [zed relationship delete](zed_relationship_delete.md) - Deletes a relationship +* [zed relationship read](zed_relationship_read.md) - Enumerates relationships matching the provided pattern +* [zed relationship touch](zed_relationship_touch.md) - Idempotently updates a relationship for a subject +* [zed relationship watch](zed_relationship_watch.md) - Watches the stream of relationship updates from the server + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_relationship_bulk-delete.md b/pages/zed/zed_relationship_bulk-delete.md new file mode 100644 index 00000000..ab942c4c --- /dev/null +++ b/pages/zed/zed_relationship_bulk-delete.md @@ -0,0 +1,39 @@ +## zed relationship bulk-delete + +Deletes relationships matching the provided pattern en masse + +``` +zed relationship bulk-delete [flags] +``` + +### Options + +``` + --force force deletion of all elements in batches defined by + -h, --help help for bulk-delete + --optional-limit uint32 the max amount of elements to delete. If you want to delete all in batches of size , set --force to true (default 1000) + --subject-filter string optional subject filter +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed relationship](zed_relationship.md) - Query and mutate the relationships in a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_relationship_create.md b/pages/zed/zed_relationship_create.md new file mode 100644 index 00000000..6123fe48 --- /dev/null +++ b/pages/zed/zed_relationship_create.md @@ -0,0 +1,39 @@ +## zed relationship create + +Create a relationship for a subject + +``` +zed relationship create [flags] +``` + +### Options + +``` + -b, --batch-size int batch size when writing streams of relationships from stdin (default 100) + --caveat string the caveat for the relationship, with format: 'caveat_name:{"some":"context"}' + -h, --help help for create + --json output as JSON +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed relationship](zed_relationship.md) - Query and mutate the relationships in a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_relationship_delete.md b/pages/zed/zed_relationship_delete.md new file mode 100644 index 00000000..34f79e8f --- /dev/null +++ b/pages/zed/zed_relationship_delete.md @@ -0,0 +1,38 @@ +## zed relationship delete + +Deletes a relationship + +``` +zed relationship delete [flags] +``` + +### Options + +``` + -b, --batch-size int batch size when deleting streams of relationships from stdin (default 100) + -h, --help help for delete + --json output as JSON +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed relationship](zed_relationship.md) - Query and mutate the relationships in a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_relationship_read.md b/pages/zed/zed_relationship_read.md new file mode 100644 index 00000000..62b29fa2 --- /dev/null +++ b/pages/zed/zed_relationship_read.md @@ -0,0 +1,52 @@ +## zed relationship read + +Enumerates relationships matching the provided pattern + +### Synopsis + +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 [flags] +``` + +### Options + +``` + --consistency-at-exactly string evaluate at the provided zedtoken + --consistency-at-least string evaluate at least as consistent as the provided zedtoken + --consistency-full evaluate at the newest zedtoken in the database + --consistency-min-latency evaluate at the zedtoken preferred by the database + -h, --help help for read + --json output as JSON + --page-limit uint32 limit of relations returned per page (default 100) + --subject-filter string optional subject filter +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed relationship](zed_relationship.md) - Query and mutate the relationships in a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_relationship_touch.md b/pages/zed/zed_relationship_touch.md new file mode 100644 index 00000000..7c7c9974 --- /dev/null +++ b/pages/zed/zed_relationship_touch.md @@ -0,0 +1,39 @@ +## zed relationship touch + +Idempotently updates a relationship for a subject + +``` +zed relationship touch [flags] +``` + +### Options + +``` + -b, --batch-size int batch size when writing streams of relationships from stdin (default 100) + --caveat string the caveat for the relationship, with format: 'caveat_name:{"some":"context"}' + -h, --help help for touch + --json output as JSON +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed relationship](zed_relationship.md) - Query and mutate the relationships in a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_relationship_watch.md b/pages/zed/zed_relationship_watch.md new file mode 100644 index 00000000..1395f149 --- /dev/null +++ b/pages/zed/zed_relationship_watch.md @@ -0,0 +1,40 @@ +## zed relationship watch + +Watches the stream of relationship updates from the server + +``` +zed relationship watch [object_types, ...] [start_cursor] [flags] +``` + +### 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 + -h, --help help for watch + --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 commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed relationship](zed_relationship.md) - Query and mutate the relationships in a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_schema.md b/pages/zed/zed_schema.md new file mode 100644 index 00000000..f95b71c4 --- /dev/null +++ b/pages/zed/zed_schema.md @@ -0,0 +1,36 @@ +## zed schema + +Manage schema for a permissions system + +### Options + +``` + -h, --help help for schema +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed](zed.md) - SpiceDB client, by AuthZed +* [zed schema copy](zed_schema_copy.md) - Copy a schema from one context into another +* [zed schema diff](zed_schema_diff.md) - Diff two schema files +* [zed schema read](zed_schema_read.md) - Read the schema of a permissions system +* [zed schema write](zed_schema_write.md) - Write a schema file (.zed or stdin) to the current permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_schema_copy.md b/pages/zed/zed_schema_copy.md new file mode 100644 index 00000000..09a7ff6a --- /dev/null +++ b/pages/zed/zed_schema_copy.md @@ -0,0 +1,38 @@ +## zed schema copy + +Copy a schema from one context into another + +``` +zed schema copy [flags] +``` + +### Options + +``` + -h, --help help for copy + --json output as JSON + --schema-definition-prefix string prefix to add to the schema's definition(s) before writing +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed schema](zed_schema.md) - Manage schema for a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_schema_diff.md b/pages/zed/zed_schema_diff.md new file mode 100644 index 00000000..186ca153 --- /dev/null +++ b/pages/zed/zed_schema_diff.md @@ -0,0 +1,36 @@ +## zed schema diff + +Diff two schema files + +``` +zed schema diff [flags] +``` + +### Options + +``` + -h, --help help for diff +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed schema](zed_schema.md) - Manage schema for a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_schema_read.md b/pages/zed/zed_schema_read.md new file mode 100644 index 00000000..b425f080 --- /dev/null +++ b/pages/zed/zed_schema_read.md @@ -0,0 +1,37 @@ +## zed schema read + +Read the schema of a permissions system + +``` +zed schema read [flags] +``` + +### Options + +``` + -h, --help help for read + --json output as JSON +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed schema](zed_schema.md) - Manage schema for a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_schema_write.md b/pages/zed/zed_schema_write.md new file mode 100644 index 00000000..b3c8383c --- /dev/null +++ b/pages/zed/zed_schema_write.md @@ -0,0 +1,38 @@ +## zed schema write + +Write a schema file (.zed or stdin) to the current permissions system + +``` +zed schema write [flags] +``` + +### Options + +``` + -h, --help help for write + --json output as JSON + --schema-definition-prefix string prefix to add to the schema's definition(s) before writing +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed schema](zed_schema.md) - Manage schema for a permissions system + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_use.md b/pages/zed/zed_use.md new file mode 100644 index 00000000..1d40a5eb --- /dev/null +++ b/pages/zed/zed_use.md @@ -0,0 +1,36 @@ +## zed use + +Alias for `zed context use` + +``` +zed use [flags] +``` + +### Options + +``` + -h, --help help for use +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed](zed.md) - SpiceDB client, by AuthZed + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_validate.md b/pages/zed/zed_validate.md new file mode 100644 index 00000000..f3395b5e --- /dev/null +++ b/pages/zed/zed_validate.md @@ -0,0 +1,60 @@ +## zed validate + +Validates the given validation file (.yaml, .zaml) or schema file (.zed) + +``` +zed validate [flags] +``` + +### Examples + +``` + + From a local file (with prefix): + zed validate file:///Users/zed/Downloads/authzed-x7izWU8_2Gw3.yaml + + From a local file (no prefix): + zed validate authzed-x7izWU8_2Gw3.yaml + + From a gist: + zed validate https://gist.github.com/ecordell/8e3b613a677e3c844742cf24421c08b6 + + From a playground link: + zed validate https://play.authzed.com/s/iksdFvCtvnkR/schema + + From pastebin: + zed validate https://pastebin.com/8qU45rVK + + From a devtools instance: + zed validate https://localhost:8443/download +``` + +### Options + +``` + --force-color force color code output even in non-tty environments + -h, --help help for validate +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed](zed.md) - SpiceDB client, by AuthZed + +###### Auto generated by spf13/cobra on 17-Jan-2025 diff --git a/pages/zed/zed_version.md b/pages/zed/zed_version.md new file mode 100644 index 00000000..4d5db92e --- /dev/null +++ b/pages/zed/zed_version.md @@ -0,0 +1,38 @@ +## zed version + +Display zed and SpiceDB version information + +``` +zed version [flags] +``` + +### Options + +``` + -h, --help help for version + --include-deps include dependencies' versions + --include-remote-version whether to display the version of Authzed or SpiceDB for the current context (default true) +``` + +### Options inherited from parent commands + +``` + --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 + --no-verify-ca do not attempt to verify the server's certificate chain and host name + --permissions-system string permissions system to query + --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 +``` + +### SEE ALSO + +* [zed](zed.md) - SpiceDB client, by AuthZed + +###### Auto generated by spf13/cobra on 17-Jan-2025