@jahia/jahia-cli 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,134 @@
+# @jahia/jahia-cli
+
+A CLI to accelerate developing and testing Jahia in the Agentic era.
+
+[![CI](https://github.com/Jahia/jahia-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/Jahia/jahia-cli/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/@jahia/jahia-cli)](https://www.npmjs.com/package/@jahia/jahia-cli)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+
+## Installation
+
+### Via npm (recommended)
+
+```bash
+npm install -g @jahia/jahia-cli
+```
+
+### Via npx (no installation)
+
+```bash
+npx @jahia/jahia-cli hello
+```
+
+## Usage
+
+```bash
+# Display help
+jahia --help
+
+# Run the hello command
+jahia hello
+
+# Greet someone by name
+jahia hello YourName
+
+# Uppercase greeting
+jahia hello --uppercase
+```
+
+## Commands
+
+### `jahia hello [NAME]`
+
+Say hello from Jahia CLI.
+
+**Arguments:**
+- `NAME` — Name to greet (default: `world`)
+
+**Flags:**
+- `-u, --uppercase` — Transform the greeting to uppercase
+
+## Development
+
+### Prerequisites
+
+- Node.js >= 20.0.0
+- npm >= 10
+
+### Setup
+
+```bash
+git clone https://github.com/Jahia/jahia-cli.git
+cd jahia-cli
+npm install
+```
+
+### Run in development
+
+```bash
+./bin/dev.js hello
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+### Test
+
+```bash
+npm test                # Run tests once
+npm run test:watch      # Run tests in watch mode
+npm run test:coverage   # Run tests with coverage
+```
+
+### Lint & Format
+
+```bash
+npm run lint        # Check for linting errors
+npm run lint:fix    # Auto-fix linting errors
+npm run format      # Format code with Prettier
+```
+
+## Project Structure
+
+```
+src/
+└── commands/       # CLI commands (one file per command)
+    └── hello.ts    # Hello world command
+test/
+└── commands/       # Test files mirror src structure
+    └── hello.test.ts
+bin/
+├── dev.js          # Dev entry point (uses tsx)
+└── run.js          # Production entry point
+```
+
+## Contributing
+
+1. Create a feature branch from `main`
+2. Make your changes following the functional programming style
+3. Ensure all tests pass: `npm test`
+4. Ensure linting passes: `npm run lint`
+5. Submit a pull request
+
+### Coding Conventions
+
+- **Functional programming**: Use arrow functions, prefer `const`, avoid mutations
+- **TypeScript strict mode**: All types must be explicit, no `any`
+- **Command classes**: OCLIF requires classes for commands, but extract logic into pure functions
+
+## Releasing
+
+Releases are managed via GitHub Releases:
+
+1. Create a new release on GitHub with a semver tag (e.g., `v1.0.0`)
+2. The release workflow automatically publishes to npm
+
+> **Note:** The repository requires an `NPM_TOKEN` secret for npm publishing.
+
+## License
+
+[Apache License 2.0](LICENSE)
+A CLI to accelerate developing and testing Jahia in the Agentic era

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S npx tsx
+
+import { execute } from '@oclif/core';
+
+await execute({ development: true, dir: import.meta.url });

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { execute } from '@oclif/core';
+
+await execute({ dir: import.meta.url });

package/dist/commands/hello.d.ts

@@ -0,0 +1,14 @@
+import { Command } from '@oclif/core';
+export declare const formatGreeting: (name: string, uppercase: boolean) => string;
+export default class Hello extends Command {
+    static args: {
+        name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        uppercase: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}
+//# sourceMappingURL=hello.d.ts.map

package/dist/commands/hello.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hello.d.ts","sourceRoot":"","sources":["../../src/commands/hello.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,OAAO,EAAS,MAAM,aAAa,CAAC;AAEnD,eAAO,MAAM,cAAc,GAAI,MAAM,MAAM,EAAE,WAAW,OAAO,KAAG,MAGjE,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,OAAO;IACxC,OAAgB,IAAI;;MAMlB;IAEF,OAAgB,WAAW,SAA8B;IAEzD,OAAgB,QAAQ,WAItB;IAEF,OAAgB,KAAK;;MAMnB;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAKlC"}

package/dist/commands/hello.js

@@ -0,0 +1,33 @@
+import { Args, Command, Flags } from '@oclif/core';
+export const formatGreeting = (name, uppercase) => {
+    const greeting = `Hello, ${name}! Welcome to Jahia CLI.`;
+    return uppercase ? greeting.toUpperCase() : greeting;
+};
+export default class Hello extends Command {
+    static args = {
+        name: Args.string({
+            description: 'Name to greet',
+            required: false,
+            default: 'world',
+        }),
+    };
+    static description = 'Say hello from Jahia CLI';
+    static examples = [
+        '<%= config.bin %> hello',
+        '<%= config.bin %> hello friend',
+        '<%= config.bin %> hello --uppercase',
+    ];
+    static flags = {
+        uppercase: Flags.boolean({
+            char: 'u',
+            description: 'Transform the greeting to uppercase',
+            default: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Hello);
+        const message = formatGreeting(args.name, flags.uppercase);
+        this.log(message);
+    }
+}
+//# sourceMappingURL=hello.js.map

package/dist/commands/hello.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hello.js","sourceRoot":"","sources":["../../src/commands/hello.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEnD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,SAAkB,EAAU,EAAE;IACzE,MAAM,QAAQ,GAAG,UAAU,IAAI,yBAAyB,CAAC;IACzD,OAAO,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;AACvD,CAAC,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,OAAO;IACxC,MAAM,CAAU,IAAI,GAAG;QACrB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;YAChB,WAAW,EAAE,eAAe;YAC5B,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,OAAO;SACjB,CAAC;KACH,CAAC;IAEF,MAAM,CAAU,WAAW,GAAG,0BAA0B,CAAC;IAEzD,MAAM,CAAU,QAAQ,GAAG;QACzB,yBAAyB;QACzB,gCAAgC;QAChC,qCAAqC;KACtC,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;YACvB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,qCAAqC;YAClD,OAAO,EAAE,KAAK;SACf,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAChD,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { run } from '@oclif/core';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { run } from '@oclif/core';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC"}

package/oclif.manifest.json

@@ -0,0 +1,45 @@
+{
+  "commands": {
+    "hello": {
+      "aliases": [],
+      "args": {
+        "name": {
+          "default": "world",
+          "description": "Name to greet",
+          "name": "name",
+          "required": false
+        }
+      },
+      "description": "Say hello from Jahia CLI",
+      "examples": [
+        "<%= config.bin %> hello",
+        "<%= config.bin %> hello friend",
+        "<%= config.bin %> hello --uppercase"
+      ],
+      "flags": {
+        "uppercase": {
+          "char": "u",
+          "description": "Transform the greeting to uppercase",
+          "name": "uppercase",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "hello",
+      "pluginAlias": "@jahia/jahia-cli",
+      "pluginName": "@jahia/jahia-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "hello.js"
+      ]
+    }
+  },
+  "version": "0.1.0"
+}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@jahia/jahia-cli",
+  "version": "0.1.0",
+  "description": "A CLI to accelerate developing and testing Jahia in the Agentic era",
+  "author": "Jahia",
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/Jahia/jahia-cli",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Jahia/jahia-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Jahia/jahia-cli/issues"
+  },
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "jahia-cli": "./bin/run.js"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "oclif.manifest.json"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "clean": "node -e \"const fs = require('fs'); ['dist', 'oclif.manifest.json'].forEach(p => fs.rmSync(p, { recursive: true, force: true }))\"",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "postbuild": "oclif manifest",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "prepack": "npm run clean && npm run build"
+  },
+  "dependencies": {
+    "@oclif/core": "^4"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.4",
+    "@oclif/test": "^4",
+    "@types/node": "^22",
+    "@typescript-eslint/eslint-plugin": "^8",
+    "@typescript-eslint/parser": "^8",
+    "@vitest/coverage-v8": "^3.2.4",
+    "eslint": "^9",
+    "eslint-config-prettier": "^10",
+    "eslint-plugin-functional": "^7",
+    "eslint-plugin-prettier": "^5",
+    "jiti": "^2.6.1",
+    "oclif": "^4",
+    "prettier": "^3",
+    "tsx": "^4",
+    "typescript": "^5.7",
+    "typescript-eslint": "^8.59.1",
+    "vitest": "^3"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "oclif": {
+    "bin": "jahia-cli",
+    "dirname": "jahia-cli",
+    "commands": {
+      "strategy": "pattern",
+      "target": "./dist/commands"
+    },
+    "topicSeparator": " "
+  }
+}