Documentation
¶
Index ¶
Constants ¶
View Source
const ( DefaultCLIName = "choreoctl" DefaultCLIShortDescription = "Welcome to Choreo CLI, " + "the command-line interface for OpenChoreo - Internal Developer Platform" ErrorPrefix = "Error: " ErrFileRequired = "no file specified\n" + "hint: use -f or --file flag to specify the configuration file\n" + "See 'choreoctl apply --help' for usage" ErrFileNotFound = "file not found at '%s'\nhint: verify the file path exists" ErrFilePermission = "permission denied accessing '%s'\nhint: check file permissions with 'ls -l'" ErrApplyFailed = "failed to apply configuration from '%s': %v\n" + "hint: validate YAML syntax and resource specifications" SuccessApplyMsg = "✓ Successfully applied configuration from '%s'\nUse 'choreoctl get' commands to view resources" KubeconfigFlagDesc = "Path to the kubeconfig file (e.g., ~/.kube/config)" KubecontextFlagDesc = "Name of the kubeconfig context (e.g., minikube)" ApplyFileFlag = "Path to the configuration file to apply (e.g., manifests/deployment.yaml)" FlagOrgDesc = "Name of the organization (e.g., acme-corp)" FlagProjDesc = "Name of the project (e.g., online-store)" FlagNameDesc = "Name of the resource (must be lowercase letters, numbers, or hyphens)" FlagURLDesc = "URL of the git repository (e.g., https://github.com/acme-corp/product-catalog)" FlagSecretRefDesc = "Secret reference for git authentication (e.g., github-token)" FlagOutputDesc = "Output format [yaml]" FlagDisplayDesc = "Display name for the component (e.g., \"Product Catalog\")" FlagDescriptionDesc = "Brief description of the organization's purpose" FlagTypeDesc = "Type of the component [WebApplication|ScheduledTask|Service]" FlagLogTypeDesc = "Type of the log [deployment, build]" FlagBuildDesc = "Name of the build (e.g., product-catalog-build-01)" FlagCompDesc = "Name of the component (e.g., product-catalog)" FlagTailDesc = "Number of lines to show from the end of logs" FlagFollowDesc = "Follow the logs of the specified resource" FlagBuildTypeDesc = "Type of the build [docker|buildpack]" FlagDockerContext = "Path to the Docker build context directory" FlagDockerfilePath = "Path to the Dockerfile" FlagBuildpackName = "Name of the buildpack" FlagBuildpackVersion = "Version of the buildpack" FlagBranchDesc = "Name of the Git branch" FlagPathDesc = "Path to the source code directory" FlagAutoBuildDesc = "Enable automatic builds" FlagRevisionDesc = "Git commit hash" FlagDeploymentTrackrDesc = "Deployment track for the component [main|feature|bugfix]" FlagDockerImageDesc = "Name of the Docker image (e.g., product-catalog:latest)" FlagEnvironmentDesc = "Environment where the component will be deployed (e.g., dev, staging, production)" FlagDeployableArtifactDesc = "Deployable artifact name (e.g., product-catalog-artifact)" FlagDeploymentDesc = "Name of the deployment (e.g., product-catalog-dev-01)" DeleteFileFlag = "Path to the configuration file to delete (e.g., manifests/deployment.yaml)" WorkloadDescriptorFlag = "Path to the workload descriptor file (e.g., workload.yaml)" FlagWaitDesc = "Wait for resources to be deleted before returning" FlagEnvironmentOrderDesc = "Comma-separated list of environment names in promotion order (e.g., dev,staging,prod)" FlagDeploymentPipelineDesc = "Name of the deployment pipeline (e.g., dev-prod-pipeline)" )
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.