From 78fc1ecdce5ab1b1ca89715a3716a235bb99cb09 Mon Sep 17 00:00:00 2001 From: ory-bot <60093411+ory-bot@users.noreply.github.com> Date: Mon, 4 Nov 2024 16:16:41 +0000 Subject: [PATCH] autogen(docs): generate cli docs --- docs/cli/ory-create-project.md | 3 ++- docs/cli/ory-get-workspace.md | 38 ++++++++++++++++++++++++++++++++++ docs/cli/ory-get.md | 1 + 3 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 docs/cli/ory-get-workspace.md diff --git a/docs/cli/ory-create-project.md b/docs/cli/ory-create-project.md index 9b0dd0b99..2d6d0cfdd 100644 --- a/docs/cli/ory-create-project.md +++ b/docs/cli/ory-create-project.md @@ -20,12 +20,13 @@ ory create project [flags] ### Options ``` + --create-workspace string Create a new workspace with the given name and use it for the project -e, --environment environment The environment of the project. Valid values are: prod, stage, dev (default dev) --format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default") -h, --help help for project -n, --name string The name of the project, required when quiet mode is used -q, --quiet Be quiet with output printing. - --use-project Set the created project as the default. + --use-project Set the created project as the default --workspace string The workspace to use, either workspace ID or a (partial) name. ``` diff --git a/docs/cli/ory-get-workspace.md b/docs/cli/ory-get-workspace.md new file mode 100644 index 000000000..075f0d02e --- /dev/null +++ b/docs/cli/ory-get-workspace.md @@ -0,0 +1,38 @@ +--- +id: ory-get-workspace +title: ory get workspace +description: ory get workspace Get an Ory Network workspaces +--- + + +## ory get workspace + +Get an Ory Network workspaces + +``` +ory get workspace [flags] +``` + +### Options + +``` + --format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default") + -h, --help help for workspace + -q, --quiet Be quiet with output printing. +``` + +### Options inherited from parent commands + +``` + -c, --config string Path to the Ory Network configuration file. + -y, --yes Confirm all dialogs with yes. +``` + +### SEE ALSO + +* [ory get](ory-get) - Get a resource + diff --git a/docs/cli/ory-get.md b/docs/cli/ory-get.md index 1fcddad38..805418e4b 100644 --- a/docs/cli/ory-get.md +++ b/docs/cli/ory-get.md @@ -32,4 +32,5 @@ Get a resource * [ory get oauth2-config](ory-get-oauth2-config) - Get Ory OAuth2 & OpenID Connect configuration. * [ory get permission-config](ory-get-permission-config) - Get Ory Permissions configuration. * [ory get project](ory-get-project) - Get the complete configuration of an Ory Network project. +* [ory get workspace](ory-get-workspace) - Get an Ory Network workspaces