corectl

README

CoreCTL - Core Platform CTL

CLI for CECG's Core Platform.

Core Platform is your ultimate all-in-one developer platform designed to turbocharge your software development journey from Day 1.

Interested in learning more about CECG's Core Platform? Book a demo at Core Platform.

Downloading

Releases for Linux and Mac are published in releases Download and unzip your platform e.g for Mac with Apple chip download corectl_Darwin_arm64.tar.gz and add to your path.

Usage

Before usage, you should initialize. It sets up your github integration with your developer environments. It requires the following:

• initialization file: init-example.yaml
• your person GitHub token to perform operations on your behalf. See more info here

NOTE: Ensure that you update init-example.yaml repositories to reference to your actual environments and software template repositories.

To run initialization run:

corectl config init

Saves configuration options and clones repositories: cplatform-environments and software-templates.

cplatform-environments - client repository that holds the configuration settings and parameters for core platform environments.

software-templates - public repository featuring bootstrap templates designed for quick project setups.

The repositories mentioned above are available for testing purposes. To gain access, you must be added to the appropriate organization and granted the necessary permissions.

Updates

Periodically update local corectl configuration by running:

corectl config update

This command will fetch latest changes for configuration repositories.

After the initialization you can start using corectl.

Commands

To check for available operations run:

corectl --help

GitHub Access Token

Classic Personal Access Token

Scopes required:

• repo, since corectl needs access to read, create repositories, create PullRequests, configure environments and variables for the repositories.
• workflow, since corectl may create workflow files when creating new applications.

Fine-grained tokens

NOTE: Your organization has to enable use of fine-grained tokens for this to be possible.

Requirements for token:

• It should have access to all your organization repositories, since corectl might be used to create and configure new repositories.
• Read-Write permissions for Administrations, since corectl might be used to create new repositories for applications.
• Read-Write permissions for Contents, since corectl will try to clone repositories with configuration and might be used to update contents of the repository.
• Read-Only permissions for Metadata, since corectl uses GitHub API with metadata to perform some logic (check if repository exists, for example).
• Read-Write permissions for Workflows, since corectl might configure workflow files when creating new applications.
• Read-Write permissions for Environments and Variables, since corectl might be used to configure P2P for repositories.
• Read-Write permissions for Pull Requests, since corectl might be used to automatically generate Pull Requests with platform configuration updates.