From c6855d6f0704b5876685ddb4a41e8ce6e599107d Mon Sep 17 00:00:00 2001 From: Eric Villa Date: Wed, 18 Oct 2023 15:40:32 +0200 Subject: [PATCH] chore: new cli docs --- packages/cli/package-lock.json | 3 ++- packages/cli/scopes/help.md | 2 +- packages/cli/scopes/idp-url.md | 8 ++++---- packages/cli/scopes/integration.md | 12 ++++++------ packages/cli/scopes/profile.md | 8 ++++---- packages/cli/scopes/region.md | 4 ++-- packages/cli/scopes/session.md | 26 +++++++++++++------------- packages/cli/scopes/set-workspace.md | 2 +- packages/cli/scopes/team.md | 6 +++--- packages/cli/scopes/version.md | 2 +- packages/cli/scopes/workspace.md | 2 +- 11 files changed, 38 insertions(+), 37 deletions(-) diff --git a/packages/cli/package-lock.json b/packages/cli/package-lock.json index f04e45980..02201bf43 100644 --- a/packages/cli/package-lock.json +++ b/packages/cli/package-lock.json @@ -93,7 +93,8 @@ } }, "../core": { - "version": "0.1.145", + "name": "@noovolari/leapp-core", + "version": "0.1.146", "dependencies": { "folder-hash": "^4.0.2", "require-module": "^0.1.0", diff --git a/packages/cli/scopes/help.md b/packages/cli/scopes/help.md index c174ed81e..416f0b2b2 100644 --- 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 index d10066b07..2601a617c 100644 --- 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 ] @@ -32,7 +32,7 @@ EXAMPLES Delete an identity provider URL -```console +``` USAGE $ leapp idp-url delete [--idpUrlId ] [-f] @@ -55,7 +55,7 @@ EXAMPLES Edit an identity provider URL -```console +``` USAGE $ leapp idp-url edit [--idpUrlId ] [--idpUrl ] @@ -76,7 +76,7 @@ EXAMPLES Show identity providers list -```console +``` USAGE $ leapp idp-url list [--columns | -x] [--sort ] [--filter ] [--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ] diff --git a/packages/cli/scopes/integration.md b/packages/cli/scopes/integration.md index 33a6a3347..749db4f66 100644 --- 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 ] [--integrationPortalUrl ] [--integrationRegion ] [--integrationType AWS-SSO|AZURE] [--integrationTenantId ] [--integrationLocation ] @@ -43,7 +43,7 @@ EXAMPLES Delete an integration -```console +``` USAGE $ leapp integration delete [--integrationId ] @@ -63,7 +63,7 @@ EXAMPLES Show integrations list -```console +``` USAGE $ leapp integration list [--columns | -x] [--sort ] [--filter ] [--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 ] @@ -110,7 +110,7 @@ EXAMPLES Logout from an integration -```console +``` USAGE $ leapp integration logout [--integrationId ] @@ -130,7 +130,7 @@ EXAMPLES Synchronize integration sessions -```console +``` USAGE $ leapp integration sync [--integrationId ] diff --git a/packages/cli/scopes/profile.md b/packages/cli/scopes/profile.md index 11f6bb1e1..9c1401a76 100644 --- 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 ] @@ -32,7 +32,7 @@ EXAMPLES Delete an AWS named profile -```console +``` USAGE $ leapp profile delete [--profileId ] [-f] @@ -55,7 +55,7 @@ EXAMPLES Rename an AWS named profile -```console +``` USAGE $ leapp profile edit [--profileId ] [--profileName ] @@ -76,7 +76,7 @@ EXAMPLES Show profile list -```console +``` USAGE $ leapp profile list [--columns | -x] [--sort ] [--filter ] [--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ] diff --git a/packages/cli/scopes/region.md b/packages/cli/scopes/region.md index c56300f5c..08a7dc333 100644 --- 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 ] diff --git a/packages/cli/scopes/session.md b/packages/cli/scopes/session.md index ec7034604..32f8c7d33 100644 --- 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 ] [--idpArn ] [--idpUrl ] [--mfaDevice ] [--sessionName ] [--parentSessionId ] [--profileId ] [--region ] @@ -66,7 +66,7 @@ EXAMPLES Change a session named-profile -```console +``` USAGE $ leapp session change-profile [--sessionId ] [--profileId ] @@ -87,7 +87,7 @@ EXAMPLES Change a session region -```console +``` USAGE $ leapp session change-region [--sessionId ] [--region ] @@ -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 ] [-r aws|azure] [-f ] @@ -133,7 +133,7 @@ EXAMPLES Delete a session -```console +``` USAGE $ leapp session delete [--sessionId ] [-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 | -x] [--sort ] [--filter ] [--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 ] [-p] @@ -249,7 +249,7 @@ EXAMPLES Run a Leapp Plugin -```console +``` USAGE $ leapp session run-aws-credential-plugin [--sessionId ] [--pluginName ] @@ -270,7 +270,7 @@ EXAMPLES Start a session -```console +``` USAGE $ leapp session start [SESSIONNAME] [--sessionId ] [--sessionRole ] [--noInteractive] @@ -302,7 +302,7 @@ EXAMPLES Start an AWS SSM session -```console +``` USAGE $ leapp session start-ssm-session [--sessionId ] [--region ] [--ssmInstanceId ] @@ -324,7 +324,7 @@ EXAMPLES Stop a session -```console +``` USAGE $ leapp session stop [SESSIONNAME] [--sessionId ] [--sessionRole ] [--noInteractive] diff --git a/packages/cli/scopes/set-workspace.md b/packages/cli/scopes/set-workspace.md index 6eb11a570..86a38ff13 100644 --- 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 index 85218a8ee..7073ebd53 100644 --- 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 index d7ab9dce3..397f812e9 100644 --- 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 index 634ddc8dd..7cea48e9c 100644 --- 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