@kepler-io/cli

Kepler CLI

CLI project for Kepler.

CommonJS module, because of oclif, they are not supporting building for ESM.

Run

Quick run

In this case the CLI will use current folder (./tooling-framework/cli), which is not a good idea for creating a new projects via CLI. Instead of kepler command we leverage NPM scripts, so you can replace it with yarn start.

$> yarn start

1. Build the project yarn build
2. Run with yarn start
3. You should see a help page for Kepler CLI, similar to this:

Command examples:

• yarn start --help
• yarn start new --help
• yarn start system
• yarn start ui
• yarn start ui table
• ...etc

Better way

This way is showing how to run the CLI in folder of your choice. Ideal for creating a new projects via CLI.

$> <BINPath>/run

1. Build the project yarn build
2. Copy to your clipboard path to bin folder inside the project (Example of path ~/Projects/.../tooling-framework/cli/bin)
3. Open a new terminal and navigate to some test folder (ex. ~/test-folder)
4. Run a command

Mac: ~/Projects/.../tooling-framework/cli/bin/run Win: C:\Projects\...\tooling-framework\cli\bin\run

1. You should see a help page for Kepler CLI, similar to this:

Command examples:

• <BINPath>/run --help
• <BINPath>/run new --help
• <BINPath>/run system
• <BINPath>/run new ts
• <BINPath>/run ui table
• ...etc

Installation

Kepler CLI is installable as NMP Module: npm install -g @kepler-io/cli.

Upgrade of package is available via command: npm install --global @kepler-io/cli@latest

You can list all installed packages with their versions on your machine via command: npm list --global

Packing

shebang (executable) file is located in ./bin directory.

You can test packaging locally via npm pack and install generated tar file.

npm install -g kepler-io-cli-vx.x.x.tgz

Publishing

Publishing is done via NPM (not Yarn): npm run publish-remote.

https://www.npmjs.com/search?q=kepler-io

Commands

Local development

Status	Command	Description
✅	kepler new	Create a new project with Wizard.
✅	kepler new tool	Create a new custom tool
✅	kepler new app	Create a new sample web app

Status	Command	Description
✅	kepler open [browser] [port]	Open a specific browser with a specific debugging port open
✅	kepler open wizard	Open a browser with debugging port open via wizard

Framework

Status	Command	Description
✅	kepler system	Prints a system information

Kepler CLI UI

Status	Command	Description
✅	kepler ui	Browse Kepler CLI UI with wizard
✅	kepler ui table	Prints examples of Kepler CLI Table
✅	kepler ui progress-bars	Prints examples of Kepler CLI Progress bar
✅	kepler ui tasks	Prints examples of Kepler CLI Tasks

Known Issues

Windows

1. open command causes command line to hang in Powershell on Windows. As a workaround, you can press CTRL-C in the Powershell terminal.