chore: new cli docs

Noovolari · Oct 18, 2023 · c6855d6 · c6855d6
1 parent e371d06
commit c6855d6
Show file tree

Hide file tree

Showing 11 changed files with 38 additions and 37 deletions.
diff --git a/packages/cli/package-lock.json b/packages/cli/package-lock.json
diff --git a/packages/cli/scopes/help.md b/packages/cli/scopes/help.md
@@ -9,7 +9,7 @@ Display help for leapp.
 
 Display help for leapp.
 
-```console
+```
 USAGE
   $ leapp help [COMMANDS] [-n]
 

diff --git a/packages/cli/scopes/idp-url.md b/packages/cli/scopes/idp-url.md
@@ -12,7 +12,7 @@ SAML 2.0 Identity providers URL management
 
 Create a new identity provider URL
 
-```console
+```
 USAGE
   $ leapp idp-url create [--idpUrl <value>]
 
@@ -32,7 +32,7 @@ EXAMPLES
 
 Delete an identity provider URL
 
-```console
+```
 USAGE
   $ leapp idp-url delete [--idpUrlId <value>] [-f]
 
@@ -55,7 +55,7 @@ EXAMPLES
 
 Edit an identity provider URL
 
-```console
+```
 USAGE
   $ leapp idp-url edit [--idpUrlId <value>] [--idpUrl <value>]
 
@@ -76,7 +76,7 @@ EXAMPLES
 
 Show identity providers list
 
-```console
+```
 USAGE
   $ leapp idp-url list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  |
     [--csv | --no-truncate]] [--no-header | ]

diff --git a/packages/cli/scopes/integration.md b/packages/cli/scopes/integration.md
@@ -14,7 +14,7 @@ Leapp Integrations management
 
 Create a new integration
 
-```console
+```
 USAGE
   $ leapp integration create [--integrationAlias <value>] [--integrationPortalUrl <value>] [--integrationRegion <value>]
     [--integrationType AWS-SSO|AZURE] [--integrationTenantId <value>] [--integrationLocation <value>]
@@ -43,7 +43,7 @@ EXAMPLES
 
 Delete an integration
 
-```console
+```
 USAGE
   $ leapp integration delete [--integrationId <value>]
 
@@ -63,7 +63,7 @@ EXAMPLES
 
 Show integrations list
 
-```console
+```
 USAGE
   $ leapp integration list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  |
     [--csv | --no-truncate]] [--no-header | ]
@@ -90,7 +90,7 @@ EXAMPLES
 
 Login to synchronize integration sessions
 
-```console
+```
 USAGE
   $ leapp integration login [--integrationId <value>]
 
@@ -110,7 +110,7 @@ EXAMPLES
 
 Logout from an integration
 
-```console
+```
 USAGE
   $ leapp integration logout [--integrationId <value>]
 
@@ -130,7 +130,7 @@ EXAMPLES
 
 Synchronize integration sessions
 
-```console
+```
 USAGE
   $ leapp integration sync [--integrationId <value>]
 

diff --git a/packages/cli/scopes/profile.md b/packages/cli/scopes/profile.md
@@ -12,7 +12,7 @@ Leapp AWS Multi-profile management
 
 Create a new AWS named profile
 
-```console
+```
 USAGE
   $ leapp profile create [--profileName <value>]
 
@@ -32,7 +32,7 @@ EXAMPLES
 
 Delete an AWS named profile
 
-```console
+```
 USAGE
   $ leapp profile delete [--profileId <value>] [-f]
 
@@ -55,7 +55,7 @@ EXAMPLES
 
 Rename an AWS named profile
 
-```console
+```
 USAGE
   $ leapp profile edit [--profileId <value>] [--profileName <value>]
 
@@ -76,7 +76,7 @@ EXAMPLES
 
 Show profile list
 
-```console
+```
 USAGE
   $ leapp profile list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  |
     [--csv | --no-truncate]] [--no-header | ]

diff --git a/packages/cli/scopes/region.md b/packages/cli/scopes/region.md
@@ -10,7 +10,7 @@ Leapp regions management
 
 Displays the default region
 
-```console
+```
 USAGE
   $ leapp region get-default
 
@@ -25,7 +25,7 @@ EXAMPLES
 
 Change the default region
 
-```console
+```
 USAGE
   $ leapp region set-default [--region <value>]
 

diff --git a/packages/cli/scopes/session.md b/packages/cli/scopes/session.md
@@ -21,7 +21,7 @@ Sessions management
 
 Add a new session
 
-```console
+```
 USAGE
   $ leapp session add [--providerType aws] [--accessKey <value>] [--idpArn <value>] [--idpUrl <value>]
     [--mfaDevice <value>] [--sessionName <value>] [--parentSessionId <value>] [--profileId <value>] [--region <value>]
@@ -66,7 +66,7 @@ EXAMPLES
 
 Change a session named-profile
 
-```console
+```
 USAGE
   $ leapp session change-profile [--sessionId <value>] [--profileId <value>]
 
@@ -87,7 +87,7 @@ EXAMPLES
 
 Change a session region
 
-```console
+```
 USAGE
   $ leapp session change-region [--sessionId <value>] [--region <value>]
 
@@ -108,7 +108,7 @@ EXAMPLES
 
 Provides info about the current active session for a selected profile (if no profile is provided, it uses the profile default)
 
-```console
+```
 USAGE
   $ leapp session current [-i] [-p <value>] [-r aws|azure] [-f <value>]
 
@@ -133,7 +133,7 @@ EXAMPLES
 
 Delete a session
 
-```console
+```
 USAGE
   $ leapp session delete [--sessionId <value>] [-f]
 
@@ -156,7 +156,7 @@ EXAMPLES
 
 Generate STS temporary credentials for the given AWS session id
 
-```console
+```
 USAGE
   $ leapp session generate SESSIONID
 
@@ -174,7 +174,7 @@ EXAMPLES
 
 Get session id
 
-```console
+```
 USAGE
   $ leapp session get-id
 
@@ -189,7 +189,7 @@ EXAMPLES
 
 Show sessions list with all properties; filter query is case sensitive
 
-```console
+```
 USAGE
   $ leapp session list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  |
     [--csv | --no-truncate]] [--no-header | ]
@@ -228,7 +228,7 @@ EXAMPLES
 
 Open an AWS Web Console
 
-```console
+```
 USAGE
   $ leapp session open-web-console [--sessionId <value>] [-p]
 
@@ -249,7 +249,7 @@ EXAMPLES
 
 Run a Leapp Plugin
 
-```console
+```
 USAGE
   $ leapp session run-aws-credential-plugin [--sessionId <value>] [--pluginName <value>]
 
@@ -270,7 +270,7 @@ EXAMPLES
 
 Start a session
 
-```console
+```
 USAGE
   $ leapp session start [SESSIONNAME] [--sessionId <value>] [--sessionRole <value>] [--noInteractive]
 
@@ -302,7 +302,7 @@ EXAMPLES
 
 Start an AWS SSM session
 
-```console
+```
 USAGE
   $ leapp session start-ssm-session [--sessionId <value>] [--region <value>] [--ssmInstanceId <value>]
 
@@ -324,7 +324,7 @@ EXAMPLES
 
 Stop a session
 
-```console
+```
 USAGE
   $ leapp session stop [SESSIONNAME] [--sessionId <value>] [--sessionRole <value>] [--noInteractive]
 

diff --git a/packages/cli/scopes/set-workspace.md b/packages/cli/scopes/set-workspace.md
@@ -9,7 +9,7 @@ Set the current Leapp workspace
 
 Set the current Leapp workspace
 
-```console
+```
 USAGE
   $ leapp set-workspace [WORKSPACENAME]
 

diff --git a/packages/cli/scopes/team.md b/packages/cli/scopes/team.md
@@ -11,7 +11,7 @@ Login to your Team account
 
 Login to your Team account
 
-```console
+```
 USAGE
   $ leapp team login
 
@@ -26,7 +26,7 @@ EXAMPLES
 
 Logout from your Team account
 
-```console
+```
 USAGE
   $ leapp team logout
 
@@ -41,7 +41,7 @@ EXAMPLES
 
 Get the team login status
 
-```console
+```
 USAGE
   $ leapp team status
 

diff --git a/packages/cli/scopes/version.md b/packages/cli/scopes/version.md
@@ -9,7 +9,7 @@ Displays the Cli and Core versions
 
 Displays the Cli and Core versions
 
-```console
+```
 USAGE
   $ leapp version
 

diff --git a/packages/cli/scopes/workspace.md b/packages/cli/scopes/workspace.md
@@ -9,7 +9,7 @@ Show the current workspace
 
 Show the current workspace
 
-```console
+```
 USAGE
   $ leapp workspace