Documentation ¶
Index ¶
Constants ¶
View Source
const ( //CmdCloudUse command CmdCloudUse = "cloud" //CmdCloudShort short description CmdCloudShort = "Manage Cloud Accounts" //CmdCloudLong long description CmdCloudLong = `Connect to your cloud accounts.` //CmdCloudListShort short description CmdCloudListShort = "Show list of tokens" //CmdCloudListLong long description CmdCloudListLong = `Show list of tokens.` //CmdCloudAddShort short description CmdCloudAddShort = "Add a cloud account" //CmdCloudAddLong long description CmdCloudAddLong = `Add a cloud account.` //CmdCloudShowShort short description CmdCloudShowShort = "Show a cloud account" //CmdCloudShowLong long description CmdCloudShowLong = `Show a cloud account.` //CmdCloudDeleteShort short desription CmdCloudDeleteShort = "Delete a cloud account" //CmdCloudDeleteLong long desription CmdCloudDeleteLong = `Delete a cloud account.` // CmdFlagCloudIDLong flag CmdFlagCloudIDLong = "cloud-id" // CmdFlagCloudIDDescripton flag description CmdFlagCloudIDDescripton = "Coreo cloud id" //InfoCloudAccountDeleted info InfoCloudAccountDeleted = "Cloud account was deleted" //InfoUsingCloudAccount info InfoUsingCloudAccount = "[ OK ] Using Cloud Account ID %s\n" //ErrorCloudIDRequired error message ErrorCloudIDRequired = "Cloud Account ID is required for this command. Use flag '--cloud-id'\n" )
View Source
const ( //CmdCompositeUse command CmdCompositeUse = "composite" //CmdCompositeShort short descripton CmdCompositeShort = "Manage Composites" //CmdCompositeLong long descripton CmdCompositeLong = `` /* 239-byte string literal not displayed */ //CmdCompositeInitShort short descripton CmdCompositeInitShort = "Create a new configuration" //CmdCompositeInitLong long descripton CmdCompositeInitLong = `Configure Coreo CLI options.` //CmdCompositeInitSuccess message CmdCompositeInitSuccess = "[Done] Composite initialization completed, default files and folders were generated.\n" //CmdCompositeCreateShort short descripton CmdCompositeCreateShort = "Create new composite" //CmdCompositeCreateLong long descripton CmdCompositeCreateLong = `Create new composite.` //CmdCompositeGendocShort short descripton CmdCompositeGendocShort = "Generate readme documentation" //CmdCompositeGendocLong long descripton CmdCompositeGendocLong = `Generate readme documentation.` //CmdCompositeGendocSuccess message CmdCompositeGendocSuccess = "[Done] Composite documentation completed, README.md was generated.\n" //CmdCompositeListShort short descripton CmdCompositeListShort = "Show list of composites" //CmdCompositeListLong long descripton CmdCompositeListLong = `Show list of composites.` //CmdCompositeShowShort short descripton CmdCompositeShowShort = "Show a particular composite" //CmdCompositeShowLong long descripton CmdCompositeShowLong = `Show a particular compsoite` //CmdCompositeLayerShort short descripton CmdCompositeLayerShort = "Generate composite layer" //CmdCompositeLayerLong long descripton CmdCompositeLayerLong = `Generate composite layer.` //CmdCompositeLayerSuccess layer success CmdCompositeLayerSuccess = "Composite successfully added." //CmdCompositeExtendsShort short descripton CmdCompositeExtendsShort = "Extends a particular composite" //CmdCompositeExtendsLong long descripton CmdCompositeExtendsLong = `Extends a particular composite.` //CmdCompositeExtendsSuccess message CmdCompositeExtendsSuccess = "[Done] Composite successfully extended.\n" //InfoUsingCompsiteID informational using Composite id InfoUsingCompsiteID = "[ OK ] Using Composite ID %s\n" //ErrorCompositeIDRequired error message ErrorCompositeIDRequired = "Composite ID is required for this command. Use flag '--composite-id'\n" //CmdFlagCompositeIDLong flag CmdFlagCompositeIDLong = "composite-id" //CmdFlagCompositeIDDescription flag description CmdFlagCompositeIDDescription = "Coreo composite id" //DefaultFilesConfigYAMLContent default content DefaultFilesConfigYAMLContent = `` /* 372-byte string literal not displayed */ //DefaultFilesConfigRBContent default content DefaultFilesConfigRBContent = `` /* 372-byte string literal not displayed */ //DefaultFilesConfigYAMLName default content DefaultFilesConfigYAMLName = "config.yaml" //DefaultFilesConfigRBName default content DefaultFilesConfigRBName = "config.rb" //DefaultFilesReadMEName default content DefaultFilesReadMEName = "README.md" //DefaultFilesOrderYAMLName default content DefaultFilesOrderYAMLName = "order.yaml" //DefaultFilesOverrideFolderName default content DefaultFilesOverrideFolderName = "/overrides" //DefaultFilesOperationalScriptsFolder default content DefaultFilesOperationalScriptsFolder = "/operational-scripts" //DefaultFilesBootScriptsFolder default content DefaultFilesBootScriptsFolder = "/boot-scripts" //DefaultFilesShutdownScriptsFolder default content DefaultFilesShutdownScriptsFolder = "/shutdown-scripts" //DefaultFilesOperationalReadMeContent default content DefaultFilesOperationalReadMeContent = `` /* 158-byte string literal not displayed */ //DefaultFilesShutDownReadMeContent default content DefaultFilesShutDownReadMeContent = `` /* 235-byte string literal not displayed */ //DefaultFilesShutDownOrderYAMLContent default content DefaultFilesShutDownOrderYAMLContent = `` /* 198-byte string literal not displayed */ //DefaultFilesBootReadMeContent default content DefaultFilesBootReadMeContent = `` /* 209-byte string literal not displayed */ //DefaultFilesBootOrderYAMLContent default content DefaultFilesBootOrderYAMLContent = `` /* 185-byte string literal not displayed */ //DefautlFilesGenDocReadMeRquiredNoDefaultHeader default content DefautlFilesGenDocReadMeRquiredNoDefaultHeader = "Required variables with no default" //DefautlFilesGenDocReadMeRquiredDefaultHeader default content DefautlFilesGenDocReadMeRquiredDefaultHeader = "Required variables with default" //DefautlFilesGenDocReadMeNoRquiredNoDefaultHeader default content DefautlFilesGenDocReadMeNoRquiredNoDefaultHeader = "Optional variables with no default" //DefautlFilesGenDocReadMeNoRquiredDefaultHeader default content DefautlFilesGenDocReadMeNoRquiredDefaultHeader = "Optional variables with default" //DefaultFilesOverridesReadMeHeader default content DefaultFilesOverridesReadMeHeader = `` /* 288-byte string literal not displayed */ DefaultFilesOverridesReadMeFooter = `` /* 227-byte string literal not displayed */ //DefaultFilesReadMeCodeTicks default content DefaultFilesReadMeCodeTicks = "```" //DefaultFilesOverridesReadMeTree default content DefaultFilesOverridesReadMeTree = `` /* 195-byte string literal not displayed */ //DefaultFilesServicesFolder default content DefaultFilesServicesFolder = "/services" //DefaultFilesServicesReadMeHeader code snippet default content DefaultFilesServicesReadMeHeader = `` /* 236-byte string literal not displayed */ //DefaultFilesServicesReadMeCode code snippet default content DefaultFilesServicesReadMeCode = `` /* 496-byte string literal not displayed */ )
View Source
const ( //CmdConfigureShort short description CmdConfigureShort = "Configure CLI options" //CmdConfigureLong long description CmdConfigureLong = `` /* 945-byte string literal not displayed */ //CmdConfigurePromptAPIKEY prompt for api key CmdConfigurePromptAPIKEY = "Enter your CloudCoreo api token key (available on https://app.cloudcoreo.com under Settings -> API Tokens) [%s]: " //CmdConfigurePromptSecretKEY prompt for secret key CmdConfigurePromptSecretKEY = "Enter your CloudCoreo api token secret key (available on https://app.cloudcoreo.com under Settings -> API Tokens) [%s]: " //CmdConfigurePromptTeamID prompt for team ID CmdConfigurePromptTeamID = "Enter your default CloudCoreo team ID (available on https://app.cloudcoreo.com under Settings -> Team) [%s]: " //CmdConfigureListShort short description CmdConfigureListShort = "List all user profiles" //CmdConfigureListLong long description CmdConfigureListLong = `List all user profiles.` )
View Source
const ( //CmdGitKeyUse gitKey command CmdGitKeyUse = "git-key" //CmdGitKeyShort short description CmdGitKeyShort = "Manage Git keys" //CmdGitKeyLong long description CmdGitKeyLong = `` /* 135-byte string literal not displayed */ //CmdGitKeyListShort short description CmdGitKeyListShort = "Show Git keys associated with your Coreo team" //CmdGitKeyListLong long description CmdGitKeyListLong = `Show Git keys associated with your Coreo team.` //CmdGitKeyAddShort short description CmdGitKeyAddShort = "Add a Git key" //CmdGitKeyAddLong long description CmdGitKeyAddLong = `Add Git keys to connect private repos to your CloudCoreo account. This will allow you to create private Composites and Plans.` //CmdGitKeyShowShort short description CmdGitKeyShowShort = "Show a Git key" //CmdGitKeyShowLong long description CmdGitKeyShowLong = `Show a Git key.` //CmdGitKeyDeleteShort delete command CmdGitKeyDeleteShort = "Delete a Git key" //CmdGitKeyDeleteLong long description CmdGitKeyDeleteLong = `Delete a Git key.` // CmdFlagGitKeyIDLong flag CmdFlagGitKeyIDLong = "gitKey-id" //CmdFlagGitKeyIDDescription flag description CmdFlagGitKeyIDDescription = "Coreo Git key ID" //ErrorGitKeyIDMissing error ErrorGitKeyIDMissing = "Git Key ID is required for this command. Use flag --gitKey-id\n" //InfoUsingGitKeyID informational using git key id InfoUsingGitKeyID = "[ OK ] Using Git Key ID %s\n" )
View Source
const ( //CmdLintUse command CmdLintUse = "coreo lint [flags] PATH" //CmdLintShort short description CmdLintShort = "examines a composite for possible issues" //CmdLintLong long description CmdLintLong = `` /* 342-byte string literal not displayed */ )
View Source
const ( //CmdPlanUse plan command CmdPlanUse = "plan SUBCOMMAND" //CmdPlanFinalizeUse plan command CmdPlanFinalizeUse = "finalize [flags]" //CmdPlanShort short descripton CmdPlanShort = "Manage Plans" //CmdPlanLong long description CmdPlanLong = `Manage Plans.` //CmdPlanListShort short descripton CmdPlanListShort = "List all plans" //CmdPlanListLong long description CmdPlanListLong = `List all plans.` //CmdPlanInitShort short descripton CmdPlanInitShort = "Init a plan" //CmdPlanInitLong long description CmdPlanInitLong = `Init a plan.` //CmdPlanCreateShort short descripton CmdPlanCreateShort = "Finalize a plan" //CmdPlanCreateLong long description CmdPlanCreateLong = `Finalize a plan.` //CmdPlanDeleteShort short descripton CmdPlanDeleteShort = "Delete a plan" //CmdPlanDeleteLong long description CmdPlanDeleteLong = `Delete a plan.` //CmdPlanShowShort short descripton CmdPlanShowShort = "Show a plan" //CmdPlanShowLong long description CmdPlanShowLong = `Show a plan.` //CmdPlanDisableShort short descripton CmdPlanDisableShort = "Disable a plan" //CmdPlanDisableLong long description CmdPlanDisableLong = `Disable a plan.` //CmdPlanEnableShort short descripton CmdPlanEnableShort = "Enable a plan" //CmdPlanEnableLong long description CmdPlanEnableLong = `Enable a plan.` //CmdPlanRunShort short descripton CmdPlanRunShort = "Run a plan" //CmdPlanRunLong long description CmdPlanRunLong = `Run a plan.` //CmdFlagPlanIDLong flag CmdFlagPlanIDLong = "plan-id" //CmdFlagPlanIDDescription flag description CmdFlagPlanIDDescription = "Coreo plan id" //CmdFlagBranchLong flag CmdFlagBranchLong = "branch" //CmdFlagBranchDescription flag description CmdFlagBranchDescription = "Git branch for plan" //CmdFlagGitRevisionLong commit id flag CmdFlagGitRevisionLong = "revision" //CmdFlagGitRevisionDescription flag description CmdFlagGitRevisionDescription = "Git revision for plan" //CmdFlagCloudRegionLong cloud region flag CmdFlagCloudRegionLong = "region" //CmdFlagCloudRegionDescription flag description CmdFlagCloudRegionDescription = "Cloud region, e.g. AWS 'us-east-1'" //CmdFlagIntervalLong interval flag CmdFlagIntervalLong = "interval" //CmdFlagIntervalDescription flag description CmdFlagIntervalDescription = "Refresh rate" //CmdFlagJSONFileLong JSON file flag CmdFlagJSONFileLong = "file" //CmdFlagJSONFileShort JSON file flag CmdFlagJSONFileShort = "f" //CmdFlagJSONFileDescription JSON file description CmdFlagJSONFileDescription = "Plan config JSON file" //InfoPlanDeleted information InfoPlanDeleted = "[Done] Plan was deleted.\n" //InfoPlanJSONFileCreated plan json file creation InfoPlanJSONFileCreated = "" /* 146-byte string literal not displayed */ //InfoUsingPlanID informational using Plan id InfoUsingPlanID = "[ OK ] Using Plan ID %s\n" //ErrorPlanIDRequired error message ErrorPlanIDRequired = "Plan ID is required for this command. Use flag '--plan-id'\n" //ErrorPlanCreateJSONFileRequired error message ErrorPlanCreateJSONFileRequired = "Plan JSON file is required for this command. Use flag '--file/-f'\n" )
View Source
const ( //AccessKey api key AccessKey = "API_KEY" //SecretKey secret key SecretKey = "SECRET_KEY" //TeamID team id TeamID = "TEAM_ID" //DefaultFolder defautl folder DefaultFolder = ".cloudcoreo" //DefaultFile default file DefaultFile = "profiles.yaml" //None none None = "None" //MaskLength mask length MaskLength = 4 //Mask mask Mask = "****************" //ErrorMissingFile error ErrorMissingFile = "Missing %s file, creating it.\n" //ErrorDirectoryPathNotProvided error ErrorDirectoryPathNotProvided = "Directory path not provided.\n" //ErrorGitURLNotProvided error ErrorGitURLNotProvided = "Git url not provided. Use flag -g\n" //ErrorInvalidDirectory error ErrorInvalidDirectory = "Error switching to directory to %s. Please make sure it's a valid directory.\n" //ErrorGitSubmoduleFailed error ErrorGitSubmoduleFailed = "git submodule add failed with:\n%s\n" //ErrorGitRepoURLMissing error ErrorGitRepoURLMissing = "A SSH git repo url is required: -g\n" //ErrorInvalidGitRepoURL error ErrorInvalidGitRepoURL = "Use a SSH git repo url for example : [-g git@github.com:CloudCoreo/audit-aws.git]\n" //ErrorNameMissing error ErrorNameMissing = "Name is required for this command. Use flag --name\n" //ErrorKeyMissing error ErrorKeyMissing = "Key is required for this command. Use flag --key\n" //ErrorAPIKeyMissing error ErrorAPIKeyMissing = "Coreo API Key is required for this command. Use flag --api-key\n" //ErrorSecretMissing error ErrorSecretMissing = "Secret is required for this command. Use flag --secret\n" //ErrorAPISecretMissing error ErrorAPISecretMissing = "API Secret is required for this command. Use flag --api-secret\n" //ErrorGitInitNotRan error ErrorGitInitNotRan = "Not a git repository (or any of the parent directories): .git\n" //ErrorNoUserProfileFound error ErrorNoUserProfileFound = "No user profile found. Set profile using 'coreo configure' command\n" //ErrorAcceptsNoArgs error ErrorAcceptsNoArgs = "This command accepts no argument(s).\n" //InfoCreatingGitSubmodule info InfoCreatingGitSubmodule = "Creating gitsubmodule %s in %s...\n" //CmdFlagDirectoryLong cmd CmdFlagDirectoryLong = "directory" //CmdFlagDirectoryShort cmd CmdFlagDirectoryShort = "d" //CmdFlagDirectoryDescription cmd CmdFlagDirectoryDescription = "the working directory <fully-qualified-path>" //CmdFlagGitRepoLong cmd CmdFlagGitRepoLong = "git-repo" //CmdFlagGitRepoShort cmd CmdFlagGitRepoShort = "g" //CmdFlagGitRepoDescription cmd CmdFlagGitRepoDescription = "Git repo url" //CmdFlagNameLong cmd CmdFlagNameLong = "name" //CmdFlagNameShort cmd CmdFlagNameShort = "n" //CmdFlagNameDescription cmd CmdFlagNameDescription = "Name flag" //CmdFlagServerLong cmd CmdFlagServerLong = "add-server-directories" //CmdFlagServerShort cmd CmdFlagServerShort = "s" //CmdFlagServerDescription cmd CmdFlagServerDescription = "Create server files" //CmdFlagKeyLong cmd CmdFlagKeyLong = "key" //CmdFlagKeyShort cmd CmdFlagKeyShort = "K" //CmdFlagKeyDescription cmd CmdFlagKeyDescription = "Resource key" //CmdFlagSecretLong secret flag long CmdFlagSecretLong = "secret" //CmdFlagSecretShort secret flag short CmdFlagSecretShort = "S" //CmdFlagSecretDescription secret flag description CmdFlagSecretDescription = "Resource secret" //CmdFlagAPISecretLong secret flag long CmdFlagAPISecretLong = "api-secret" //CmdFlagAPISecretDescription api secret flag description CmdFlagAPISecretDescription = "Coreo API Secret" //CmdFlagAPIKeyLong api key flag long CmdFlagAPIKeyLong = "api-key" //CmdFlagAPIKeyDescription api key flag description CmdFlagAPIKeyDescription = "Coreo API Key" //CmdFlagTeamIDLong team id long CmdFlagTeamIDLong = "team-id" //CmdFlagTeamIDDescription team id flag description CmdFlagTeamIDDescription = "Coreo team id" //CmdFlagJSONLong json long CmdFlagJSONLong = "json" //CmdFlagJSONDescription json flag description CmdFlagJSONDescription = "Output in json format" //CmdFlagVerboseLong verbose long CmdFlagVerboseLong = "verbose" //CmdFlagVerboseDescription verbose flag description CmdFlagVerboseDescription = "Enable verbose output" //CmdFlagConfigLong config flag long CmdFlagConfigLong = "home" //CmdFlagConfigDescription config flag description CmdFlagConfigDescription = "Location of your Coreo config. Overrides $COREO_HOME." //CmdFlagProfileLong profile flag long CmdFlagProfileLong = "profile" //CmdFlagProfileDescription secret flag description CmdFlagProfileDescription = "Coreo profile to use." //CmdFlagAPIEndpointLong api endpoint flag long CmdFlagAPIEndpointLong = "endpoint" //CmdFlagAPIEndpointDescription api endpoint description CmdFlagAPIEndpointDescription = "Coreo API endpoint. Overrides CC_API_ENDPOINT." //CmdCoreoUse Coreo cmd CmdCoreoUse = "coreo" //CmdCoreoShort Coreo short description CmdCoreoShort = "CloudCoreo CLI" //CmdCoreoLong Coreo long description CmdCoreoLong = `CloudCoreo CLI.` //CmdConfigureUse configure cmd CmdConfigureUse = "configure" //CmdListUse list cmd CmdListUse = "list" //CmdAddUse add cmd CmdAddUse = "add [flags]" //CmdDeleteUse delete cmd CmdDeleteUse = "delete [flags]" //CmdShowUse show cmd CmdShowUse = "show [flags]" //CmdDisableUse disable cmd CmdDisableUse = "disable [flags]" //CmdEnableUse enable cmd CmdEnableUse = "enable [flags]" //CmdRunUse run cmd CmdRunUse = "run [flags]" //CmdInitUse init cmd CmdInitUse = "init [flags]" //CmdGendocUse gendoc cmd CmdGendocUse = "gendoc [flags]" //CmdLayerUse layer cmd CmdLayerUse = "layer [flags]" //CmdExtendsUse extends cmd CmdExtendsUse = "extends [flags]" //InfoUsingProfile info using profile InfoUsingProfile = "[ OK ] Using Profile %s\n" //InfoCommandSuccess info command was executed successfully InfoCommandSuccess = "[ OK ] Command was executed successfully" )
View Source
const ( //CmdTeamUse team command CmdTeamUse = "team" //CmdTeamShort short description CmdTeamShort = "Manage Teams" //CmdTeamLong long descripton CmdTeamLong = `Manage Teams.` //CmdTeamListShort short description CmdTeamListShort = "Show list of team" //CmdTeamListLong long descripton CmdTeamListLong = `Show list of team.` //CmdTeamShowShort short description CmdTeamShowShort = "Show a team" //CmdTeamShowLong long descripton CmdTeamShowLong = `Show a team.` //InfoUsingTeamID informational using team id InfoUsingTeamID = "[ OK ] Using Team ID %s\n" //ErrorTeamIDMissing error ErrorTeamIDMissing = "Team ID is required for this command. Use flag --team-id\n" )
View Source
const ( //CmdTokenUse token command CmdTokenUse = "token" //CmdTokenShort short descripton CmdTokenShort = "Manage API Tokens" //CmdTokenLong long description CmdTokenLong = `Manage API Tokens.` //CmdTokenListShort short descripton CmdTokenListShort = "Show list of tokens" //CmdTokenListLong long description CmdTokenListLong = `Show list of tokens.` //CmdTokenAddShort short descripton CmdTokenAddShort = "Add a token" //CmdTokenAddLong long description CmdTokenAddLong = `Add a token.` //CmdTokenShowShort short descripton CmdTokenShowShort = "Show a token" //CmdTokenShowLong long description CmdTokenShowLong = `Show a token.` //CmdTokenDeleteShort short descripton CmdTokenDeleteShort = "Delete a token" //CmdTokenDeleteLong long description CmdTokenDeleteLong = `Delete a token.` //CmdFlagTokenIDLong flag CmdFlagTokenIDLong = "token-id" //CmdFlagTokenIDDescription flag description CmdFlagTokenIDDescription = "Coreo token id" //InfoUsingTokenID informational using Token id InfoUsingTokenID = "[ OK ] Using Token ID %s\n" //InfoTokenDeleted information InfoTokenDeleted = "[ DONE ] Token was deleted.\n" //ErrorTokenIDMissing error ErrorTokenIDMissing = "Token ID is required for this command. Use flag --token-id\n" )
View Source
const ( // CmdVersionUse command CmdVersionUse = "version" //CmdVersionShort command CmdVersionShort = "Print the version number of Coreo CLI" //CmdVersionLong command CmdVersionLong = `Print the version number of Coreo CLI.` )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.