@laioutr/cli 0.2.0

package/README.md

@@ -0,0 +1,380 @@
+# @laioutr/cli
+
+Laioutr CLI
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/@laioutr/cli.svg)](https://npmjs.org/package/@laioutr/cli)
+[![Downloads/week](https://img.shields.io/npm/dw/@laioutr/cli.svg)](https://npmjs.org/package/@laioutr/cli)
+
+<!-- toc -->
+* [@laioutr/cli](#laioutrcli)
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+
+# Usage
+
+<!-- usage -->
+```sh-session
+$ npm install -g @laioutr/cli
+$ laioutr COMMAND
+running command...
+$ laioutr (--version)
+@laioutr/cli/0.2.0 darwin-arm64 node-v22.12.0
+$ laioutr --help [COMMAND]
+USAGE
+  $ laioutr COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+
+<!-- commands -->
+* [`laioutr help [COMMAND]`](#laioutr-help-command)
+* [`laioutr plugins`](#laioutr-plugins)
+* [`laioutr plugins add PLUGIN`](#laioutr-plugins-add-plugin)
+* [`laioutr plugins:inspect PLUGIN...`](#laioutr-pluginsinspect-plugin)
+* [`laioutr plugins install PLUGIN`](#laioutr-plugins-install-plugin)
+* [`laioutr plugins link PATH`](#laioutr-plugins-link-path)
+* [`laioutr plugins remove [PLUGIN]`](#laioutr-plugins-remove-plugin)
+* [`laioutr plugins reset`](#laioutr-plugins-reset)
+* [`laioutr plugins uninstall [PLUGIN]`](#laioutr-plugins-uninstall-plugin)
+* [`laioutr plugins unlink [PLUGIN]`](#laioutr-plugins-unlink-plugin)
+* [`laioutr plugins update`](#laioutr-plugins-update)
+* [`laioutr project fetch-rc [FILENAME]`](#laioutr-project-fetch-rc-filename)
+
+## `laioutr help [COMMAND]`
+
+Display help for laioutr.
+
+```
+USAGE
+  $ laioutr help [COMMAND...] [-n]
+
+ARGUMENTS
+  COMMAND...  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for laioutr.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.29/src/commands/help.ts)_
+
+## `laioutr plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ laioutr plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ laioutr plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.41/src/commands/plugins/index.ts)_
+
+## `laioutr plugins add PLUGIN`
+
+Installs a plugin into laioutr.
+
+```
+USAGE
+  $ laioutr plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into laioutr.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the LAIOUTR_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the LAIOUTR_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ laioutr plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ laioutr plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ laioutr plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ laioutr plugins add someuser/someplugin
+```
+
+## `laioutr plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ laioutr plugins inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN...  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ laioutr plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.41/src/commands/plugins/inspect.ts)_
+
+## `laioutr plugins install PLUGIN`
+
+Installs a plugin into laioutr.
+
+```
+USAGE
+  $ laioutr plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into laioutr.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the LAIOUTR_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the LAIOUTR_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ laioutr plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ laioutr plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ laioutr plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ laioutr plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.41/src/commands/plugins/install.ts)_
+
+## `laioutr plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ laioutr plugins link PATH [-h] [--install] [-v]
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help          Show CLI help.
+  -v, --verbose
+      --[no-]install  Install dependencies after linking the plugin.
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ laioutr plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.41/src/commands/plugins/link.ts)_
+
+## `laioutr plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ laioutr plugins remove [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ laioutr plugins unlink
+  $ laioutr plugins remove
+
+EXAMPLES
+  $ laioutr plugins remove myplugin
+```
+
+## `laioutr plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ laioutr plugins reset [--hard] [--reinstall]
+
+FLAGS
+  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
+  --reinstall  Reinstall all plugins after uninstalling.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.41/src/commands/plugins/reset.ts)_
+
+## `laioutr plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ laioutr plugins uninstall [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ laioutr plugins unlink
+  $ laioutr plugins remove
+
+EXAMPLES
+  $ laioutr plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.41/src/commands/plugins/uninstall.ts)_
+
+## `laioutr plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ laioutr plugins unlink [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ laioutr plugins unlink
+  $ laioutr plugins remove
+
+EXAMPLES
+  $ laioutr plugins unlink myplugin
+```
+
+## `laioutr plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ laioutr plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.41/src/commands/plugins/update.ts)_
+
+## `laioutr project fetch-rc [FILENAME]`
+
+Fetches the laioutrrc.json of a project from the cockpit api.
+
+```
+USAGE
+  $ laioutr project fetch-rc [FILENAME] --cockpitApiHost <value> --cwd <value> -e <value> -s <value> -p <value>
+
+FLAGS
+  -e, --environmentName=<value>  (required) [default: main] environment name
+  -p, --project=<value>          (required) <organization slug>/<project slug>
+  -s, --projectSecret=<value>    (required) project secret
+      --cockpitApiHost=<value>   (required) [default: https://cockpit.laioutr.cloud] cockpit api host
+      --cwd=<value>              (required) [default: /Users/sl/src/laioutr/apps/cli] current working directory
+
+DESCRIPTION
+  Fetches the laioutrrc.json of a project from the cockpit api.
+
+EXAMPLES
+  $ laioutr project fetch-rc
+```
+
+_See code: [src/commands/project/fetch-rc.ts](https://github.com/packages/cli/blob/v0.2.0/src/commands/project/fetch-rc.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+import { execute } from '@oclif/core';
+
+await execute({ development: true, dir: import.meta.url });

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

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/project/fetch-rc.d.ts

@@ -0,0 +1,17 @@
+import LaioutrBaseCommand from '../../laioutr-base-command.js';
+export default class ProjectFetchRc extends LaioutrBaseCommand {
+    static args: {
+        fileName: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        environmentName: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        projectSecret: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        project: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        cockpitApiHost: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        cwd: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+    private fetchRc;
+}

package/dist/commands/project/fetch-rc.js

@@ -0,0 +1,52 @@
+import { writeFile } from 'node:fs/promises';
+import path from 'node:path';
+import { Args, Flags } from '@oclif/core';
+import { z } from 'zod/v4';
+import LaioutrBaseCommand from '../../laioutr-base-command.js';
+const apiResponseSchema = z.object({
+    content: z.string(),
+});
+export default class ProjectFetchRc extends LaioutrBaseCommand {
+    static args = {
+        ...LaioutrBaseCommand.args,
+        fileName: Args.string({ default: 'laioutrrc.json', name: 'fileName', required: false }),
+    };
+    static description = 'Fetches the laioutrrc.json of a project from the cockpit api.';
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {
+        ...LaioutrBaseCommand.flags,
+        environmentName: Flags.string({ char: 'e', default: 'main', description: 'environment name', env: 'ENVIRONMENT_NAME', required: true }),
+        projectSecret: Flags.string({ char: 's', description: 'project secret', env: 'PROJECT_SECRET', required: true }),
+        project: Flags.string({ char: 'p', description: '<organization slug>/<project slug>', env: 'PROJECT', required: true }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(ProjectFetchRc);
+        const rc = await this.fetchRc(flags);
+        const filePath = path.join(flags.cwd, args.fileName);
+        this.log('Writing RC file', filePath);
+        return writeFile(filePath, rc);
+    }
+    async fetchRc(flags) {
+        const url = `${flags.cockpitApiHost}/api/v1/project/fetch-rc`;
+        const [organizationSlug, projectSlug] = flags.project.split('/');
+        const response = await fetch(url, {
+            body: JSON.stringify({
+                environmentName: flags.environmentName,
+                organizationSlug,
+                projectSecret: flags.projectSecret,
+                projectSlug,
+            }),
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            method: 'POST',
+        });
+        const data = await response.json();
+        if (response.status !== 200) {
+            this.log(data);
+            this.error('Failed to fetch RC file. See error message above.', { exit: 1 });
+        }
+        const parsed = apiResponseSchema.parse(data);
+        return parsed.content;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/laioutr-base-command.d.ts

@@ -0,0 +1,8 @@
+import { Command } from '@oclif/core';
+export default abstract class LaioutrBaseCommand extends Command {
+    static args: {};
+    static flags: {
+        cockpitApiHost: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        cwd: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+}

package/dist/laioutr-base-command.js

@@ -0,0 +1,18 @@
+import { Command, Flags } from '@oclif/core';
+export default class LaioutrBaseCommand extends Command {
+    static args = {};
+    static flags = {
+        cockpitApiHost: Flags.string({
+            default: 'https://cockpit.laioutr.cloud',
+            description: 'cockpit api host',
+            env: 'COCKPIT_API_HOST',
+            required: true,
+        }),
+        cwd: Flags.string({
+            default: process.cwd(),
+            description: 'current working directory',
+            env: 'CWD',
+            required: true,
+        }),
+    };
+}

package/oclif.manifest.json

@@ -0,0 +1,87 @@
+{
+  "commands": {
+    "project:fetch-rc": {
+      "aliases": [],
+      "args": {
+        "fileName": {
+          "default": "laioutrrc.json",
+          "name": "fileName",
+          "required": false
+        }
+      },
+      "description": "Fetches the laioutrrc.json of a project from the cockpit api.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "cockpitApiHost": {
+          "description": "cockpit api host",
+          "env": "COCKPIT_API_HOST",
+          "name": "cockpitApiHost",
+          "required": true,
+          "default": "https://cockpit.laioutr.cloud",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "cwd": {
+          "description": "current working directory",
+          "env": "CWD",
+          "name": "cwd",
+          "required": true,
+          "default": "/Users/sl/src/laioutr/apps/cli",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "environmentName": {
+          "char": "e",
+          "description": "environment name",
+          "env": "ENVIRONMENT_NAME",
+          "name": "environmentName",
+          "required": true,
+          "default": "main",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "projectSecret": {
+          "char": "s",
+          "description": "project secret",
+          "env": "PROJECT_SECRET",
+          "name": "projectSecret",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "project": {
+          "char": "p",
+          "description": "<organization slug>/<project slug>",
+          "env": "PROJECT",
+          "name": "project",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "project:fetch-rc",
+      "pluginAlias": "@laioutr/cli",
+      "pluginName": "@laioutr/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "project",
+        "fetch-rc.js"
+      ]
+    }
+  },
+  "version": "0.2.0"
+}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@laioutr/cli",
+  "version": "0.2.0",
+  "description": "Laioutr CLI",
+  "repository": "packages/cli",
+  "author": "Laioutr GmbH",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "laioutr": "./bin/run.js"
+  },
+  "files": [
+    "/bin",
+    "/dist",
+    "/oclif.manifest.json"
+  ],
+  "lint-staged": {
+    "*.{js,mjs,jsx,ts,tsx,vue}": [
+      "pnpm lint --fix",
+      "prettier --cache --write"
+    ],
+    "*.{css,scss,md,html,json}": "prettier --cache --write"
+  },
+  "oclif": {
+    "bin": "laioutr",
+    "commands": "./dist/commands",
+    "dirname": "laioutr",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " "
+  },
+  "dependencies": {
+    "@oclif/core": "^4",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5",
+    "zod": "3.25.61"
+  },
+  "devDependencies": {
+    "@oclif/test": "^4",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "latest",
+    "chai": "^4",
+    "mocha": "^10",
+    "oclif": "^4",
+    "shx": "^0.3.3",
+    "ts-node": "^10",
+    "typescript": "^5.7.2"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "dev": "./bin/dev.js",
+    "lint": "eslint --cache --cache-location ../../.eslintcache",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "posttest": "pnpm run lint",
+    "version": "oclif readme && git add README.md"
+  }
+}