Kog - CLI

Kog CLI is a command-line tool engineered to streamline the initiation of your projects with Kreate templates and the integration of Kog components.

Documentation

Kog CLI documentation is still in development, but will be made available at https://custom-d.customd.io/npm/custom-kog

Setup

To install Kog CLI, run the following command:

npm install -g @customd/kog

Usage

Help

For command help output, run:

kog help <command>

E.g.,

kog help init

Configure GitLab access

To configure the CLI tool for GitLab access, run kog configure. The command will prompt you for your GitLab instance URL, and Personal Access Token. This token requires at least (api) permission.

kog configure

This CLI tool shares configuration with other @customd/ CLI tools.

Initialize a new project

To initialize a new project with Kog CLI, navigate to your desired directory and run the following command:

kog init <project-name>

Substitute with your desired project name.

Example

To set up a new project called 'my-project' in the 'Project' directory using the 'kreate' template, execute the following command:

kog init my-project --cwd ~/Projects/ --template kreate --override

Add a component

To add a Kog component to your project, navigate to your project's directory and run the following command:

kog add <component-name>

Replace with the name of the Kog component you wish to add. This command will add the specified component to your project and install all required dependencies.

Example

Executing this command will incorporate the 'Demo' component into your project:

kog add Demo

Executing the 'add' command without any parameters will present a list of all accessible components:

kog add

Uninstallation

To uninstall Kog CLI, run the following command:

npm uninstall -g @customd/kog

License

Licensed under the MIT license.