autogen(docs): regenerate ory/cli reference

ory · May 28, 2021 · 227b5a9 · 227b5a9
1 parent 4d9baa4
commit 227b5a9
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 75 deletions.
diff --git a/docs/docs/cli/ory-identities-delete.md b/docs/docs/cli/ory-identities-delete.md
@@ -9,20 +9,16 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## ory identities delete
 
 Delete identities by ID
 
 ### Synopsis
 
-This command deletes one or more identities by ID. To delete an identity by some
-selector, e.g. the recovery email address, use the list command in combination
-with jq.
+This command deletes one or more identities by ID. To delete an identity by some selector, e.g. the recovery email address, use the list command in combination with jq.
+
+We have to admit, this is not easy if you don&#39;t speak jq fluently. What about opening an issue and telling us what predefined selectors you want to have? https://github.com/ory/kratos/issues/new/choose
 
-We have to admit, this is not easy if you don&#39;t speak jq fluently. What
-about opening an issue and telling us what predefined selectors you want to
-have? https://github.com/ory/kratos/issues/new/choose
 
 ```
 ory identities delete &lt;id-0 [id-1 ...]&gt; [flags]
@@ -51,4 +47,5 @@ To delete the identity with the recovery email address &#34;foo@bar.com&#34;, ru
 
 ### SEE ALSO
 
-- [ory identities](ory-identities) - Manage your identities
+* [ory identities](ory-identities)	 - Manage your identities
+
diff --git a/docs/docs/cli/ory-identities-get.md b/docs/docs/cli/ory-identities-get.md
@@ -9,20 +9,16 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## ory identities get
 
 Get one or more identities by ID
 
 ### Synopsis
 
-This command gets all the details about an identity. To get an identity by some
-selector, e.g. the recovery email address, use the list command in combination
-with jq.
+This command gets all the details about an identity. To get an identity by some selector, e.g. the recovery email address, use the list command in combination with jq.
+
+We have to admit, this is not easy if you don&#39;t speak jq fluently. What about opening an issue and telling us what predefined selectors you want to have? https://github.com/ory/kratos/issues/new/choose
 
-We have to admit, this is not easy if you don&#39;t speak jq fluently. What
-about opening an issue and telling us what predefined selectors you want to
-have? https://github.com/ory/kratos/issues/new/choose
 
 ```
 ory identities get &lt;id-0 [id-1 ...]&gt; [flags]
@@ -53,4 +49,5 @@ To get the identities with the recovery email address at the domain &#34;ory.sh&
 
 ### SEE ALSO
 
-- [ory identities](ory-identities) - Manage your identities
+* [ory identities](ory-identities)	 - Manage your identities
+
diff --git a/docs/docs/cli/ory-identities-list.md b/docs/docs/cli/ory-identities-list.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## ory identities list
 
 List identities
@@ -39,4 +38,5 @@ ory identities list [&lt;page&gt; &lt;per-page&gt;] [flags]
 
 ### SEE ALSO
 
-- [ory identities](ory-identities) - Manage your identities
+* [ory identities](ory-identities)	 - Manage your identities
+
diff --git a/docs/docs/cli/ory-identities.md b/docs/docs/cli/ory-identities.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## ory identities
 
 Manage your identities
@@ -24,7 +23,8 @@ Manage your identities
 
 ### SEE ALSO
 
-- [ory](ory) - The ORY CLI
-- [ory identities delete](ory-identities-delete) - Delete identities by ID
-- [ory identities get](ory-identities-get) - Get one or more identities by ID
-- [ory identities list](ory-identities-list) - List identities
+* [ory](ory)	 - The ORY CLI
+* [ory identities delete](ory-identities-delete)	 - Delete identities by ID
+* [ory identities get](ory-identities-get)	 - Get one or more identities by ID
+* [ory identities list](ory-identities-list)	 - List identities
+
diff --git a/docs/docs/cli/ory-proxy-local.md b/docs/docs/cli/ory-proxy-local.md
@@ -1,68 +1,64 @@
 ---
 id: ory-proxy-local
 title: ory proxy local
-description:
-  ory proxy local Develop an application locally and integrate it with Ory
+description: ory proxy local Develop an application locally and integrate it with Ory
 ---
 
 <!--
 This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## ory proxy local
 
 Develop an application locally and integrate it with Ory
 
 ### Synopsis
 
-This command starts a reverse proxy which can be deployed in front of your
-application. This works best on local (your computer) environments, for example
-when developing a React, NodeJS, Java, PHP app.
+This command starts a reverse proxy which can be deployed in front of your application. This works best on local (your computer) environments, for example when developing a React, NodeJS, Java, PHP app.
 
-To require login before accessing paths in your application, use the
---protect-path-prefix flag:
+To require login before accessing paths in your application, use the --protect-path-prefix flag:
 
-    $ ory local proxy --port 4000 http://localhost:3000 --protect-path-prefix /members --protect-path-prefix /admin
+	$ ory local proxy --port 4000 http://localhost:3000 --protect-path-prefix /members --protect-path-prefix /admin
 
-The --protect-path-prefix flag is currently using a string prefix match. Future
-versions will include support for regular expressions and glob matching.
+The --protect-path-prefix flag is currently using a string prefix match. Future versions will
+include support for regular expressions and glob matching.
 
-If the request is authenticated, a JSON Web Token will be sent in the HTTP
-Authorization Header containing the Ory Session:
+If the request is authenticated, a JSON Web Token will be sent in the HTTP Authorization Header containing the
+Ory Session:
 
-    GET / HTTP/1.1
-    Host: www.example.com
-    Authorization Bearer &lt;the-json-web-token&gt;
+	GET / HTTP/1.1
+	Host: www.example.com
+	Authorization Bearer &lt;the-json-web-token&gt;
 
 The JSON Web Token claims contain:
 
-- The &#34;sub&#34; field which is set to the Ory Identity ID.
-- The &#34;session&#34; field which contains the full Ory Session.
+* The &#34;sub&#34; field which is set to the Ory Identity ID.
+* The &#34;session&#34; field which contains the full Ory Session.
 
-The JSON Web Token is signed using the ES256 algorithm. The public key can be
-found by fetching the /.ory/jwks.json path when calling the proxy - for example
-http://127.0.0.1:4000/.ory/jwks.json
+The JSON Web Token is signed using the ES256 algorithm. The public key can be found by fetching the /.ory/jwks.json path
+when calling the proxy - for example http://127.0.0.1:4000/.ory/jwks.json
 
 An example payload of the JSON Web Token is:
 
-    {
-      &#34;id&#34;: &#34;821f5a53-a0b3-41fa-9c62-764560fa4406&#34;,
-      &#34;active&#34;: true,
-      &#34;expires_at&#34;: &#34;2021-02-25T09:25:37.929792Z&#34;,
-      &#34;authenticated_at&#34;: &#34;2021-02-24T09:25:37.931774Z&#34;,
-      &#34;issued_at&#34;: &#34;2021-02-24T09:25:37.929813Z&#34;,
-      &#34;identity&#34;: {
-    	&#34;id&#34;: &#34;18aafd3e-b00c-4b19-81c8-351e38705126&#34;,
-    	&#34;schema_id&#34;: &#34;default&#34;,
-    	&#34;schema_url&#34;: &#34;https://example.projects.oryapis.com/api/kratos/public/schemas/default&#34;,
-    	&#34;traits&#34;: {
-    	  &#34;email&#34;: &#34;foo@bar&#34;,
-    	  // ... your other identity traits
-    	}
-      }
-    }
+	{
+	  &#34;id&#34;: &#34;821f5a53-a0b3-41fa-9c62-764560fa4406&#34;,
+	  &#34;active&#34;: true,
+	  &#34;expires_at&#34;: &#34;2021-02-25T09:25:37.929792Z&#34;,
+	  &#34;authenticated_at&#34;: &#34;2021-02-24T09:25:37.931774Z&#34;,
+	  &#34;issued_at&#34;: &#34;2021-02-24T09:25:37.929813Z&#34;,
+	  &#34;identity&#34;: {
+		&#34;id&#34;: &#34;18aafd3e-b00c-4b19-81c8-351e38705126&#34;,
+		&#34;schema_id&#34;: &#34;default&#34;,
+		&#34;schema_url&#34;: &#34;https://example.projects.oryapis.com/api/kratos/public/schemas/default&#34;,
+		&#34;traits&#34;: {
+		  &#34;email&#34;: &#34;foo@bar&#34;,
+		  // ... your other identity traits
+		}
+	  }
+	}
+
+
 
 ```
 ory proxy local [upstream] [flags]
@@ -82,4 +78,5 @@ ory proxy local [upstream] [flags]
 
 ### SEE ALSO
 
-- [ory proxy](ory-proxy) - Easily protect applications with the Ory Proxy
+* [ory proxy](ory-proxy)	 - Easily protect applications with the Ory Proxy
+
diff --git a/docs/docs/cli/ory-proxy.md b/docs/docs/cli/ory-proxy.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## ory proxy
 
 Easily protect applications with the Ory Proxy
@@ -22,6 +21,6 @@ Easily protect applications with the Ory Proxy
 
 ### SEE ALSO
 
-- [ory](ory) - The ORY CLI
-- [ory proxy local](ory-proxy-local) - Develop an application locally and
-  integrate it with Ory
+* [ory](ory)	 - The ORY CLI
+* [ory proxy local](ory-proxy-local)	 - Develop an application locally and integrate it with Ory
+
diff --git a/docs/docs/cli/ory-version.md b/docs/docs/cli/ory-version.md
@@ -1,17 +1,14 @@
 ---
 id: ory-version
 title: ory version
-description:
-  ory version Display this binary's version, build time, and git hash of this
-  build
+description: ory version Display this binary's version, build time, and git hash of this build
 ---
 
 <!--
 This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## ory version
 
 Display this binary&#39;s version, build time, and git hash of this build
@@ -28,4 +25,5 @@ ory version [flags]
 
 ### SEE ALSO
 
-- [ory](ory) - The ORY CLI
+* [ory](ory)	 - The ORY CLI
+
diff --git a/docs/docs/cli/ory.md b/docs/docs/cli/ory.md
@@ -9,7 +9,6 @@ This file is auto-generated.
 
 To improve this file please make your change against the appropriate "./cmd/*.go" file.
 -->
-
 ## ory
 
 The ORY CLI
@@ -22,7 +21,7 @@ The ORY CLI
 
 ### SEE ALSO
 
-- [ory identities](ory-identities) - Manage your identities
-- [ory proxy](ory-proxy) - Easily protect applications with the Ory Proxy
-- [ory version](ory-version) - Display this binary&#39;s version, build time,
-  and git hash of this build
+* [ory identities](ory-identities)	 - Manage your identities
+* [ory proxy](ory-proxy)	 - Easily protect applications with the Ory Proxy
+* [ory version](ory-version)	 - Display this binary&#39;s version, build time, and git hash of this build
+