@dirigiblelabs/dirigible-cli

Eclipse Dirigible CLI

A powerful command-line interface tool to streamline the development and management of your Eclipse Dirigible projects.

🚀 Overview

The @dirigiblelabs/dirigible-cli package is the essential external utility for developers working with Eclipse Dirigible. It abstracts the complexity of common development tasks, allowing you to interact with and manage your projects directly from your terminal using a single command: dirigible.

The CLI helps in developing Eclipse Dirigible projects by providing useful commands for typical development workflows.

📦 Installation

There are two primary ways to install and use the Dirigible CLI: globally for system-wide access, or locally as a development dependency for project-specific use.

The CLI JAR is not part of the package: the install downloads the dirigible-cli executable JAR of the same version from Maven Central and verifies its SHA-256 checksum. When the install skips scripts (--ignore-scripts, pnpm) or the download fails, the first run of dirigible downloads it instead.

1. Global Installation (Recommended for CLI Tools)

Install the CLI globally using npm to run the dirigible command directly from any directory in your terminal.

npm install -g @dirigiblelabs/dirigible-cli

2. Local Project Dependency

Install the CLI as a development dependency if you prefer to manage it per-project.

npm install --save-dev @dirigiblelabs/dirigible-cli

When installed locally, you can access the command using npx (e.g., npx dirigible <command>) or by registering scripts in your package.json.

Example of registering scripts:

// package.json
{
  ...
  "scripts": {
    "start": "dirigible start",
    "start:dev": "dirigible start --watch"
  }
}

You can then execute the script using:

npm run start

💡 Usage

The CLI is invoked using the single command dirigible.

Check All Commands

To see a comprehensive list of all supported commands, arguments, and options, execute the built-in help command:

dirigible help

This will output detailed information on how to use each feature of the CLI.

🔗 Project Resources

For comprehensive documentation, API references, and to learn more about the Eclipse Dirigible platform, please visit the official channels:

• Official GitHub Repository: https://github.com/eclipse-dirigible/dirigible
• Official Project Website: https://www.dirigible.io/