@laioutr/cli 0.2.0 → 0.3.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @laioutr/cli
 $ laioutr COMMAND
 running command...
 $ laioutr (--version)
-@laioutr/cli/0.2.0 darwin-arm64 node-v22.12.0
+@laioutr/cli/0.3.0 darwin-arm64 node-v22.12.0
 $ laioutr --help [COMMAND]
 USAGE
   $ laioutr COMMAND
@@ -43,6 +43,8 @@ USAGE
 * [`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 rc fetch [FILENAME]`](#laioutr-rc-fetch-filename)
+* [`laioutr rc update [FILENAME]`](#laioutr-rc-update-filename)
 
 ## `laioutr help [COMMAND]`
 
@@ -372,9 +374,58 @@ FLAGS
 DESCRIPTION
   Fetches the laioutrrc.json of a project from the cockpit api.
 
+ALIASES
+  $ laioutr project fetch-rc
+
 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)_
+## `laioutr rc fetch [FILENAME]`
+
+Fetches the laioutrrc.json of a project from the cockpit api.
+
+```
+USAGE
+  $ laioutr rc fetch [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.
+
+ALIASES
+  $ laioutr project fetch-rc
+
+EXAMPLES
+  $ laioutr rc fetch
+```
+
+_See code: [src/commands/rc/fetch.ts](https://github.com/packages/cli/blob/v0.3.0/src/commands/rc/fetch.ts)_
+
+## `laioutr rc update [FILENAME]`
+
+Updates an existing laioutrrc.json file with the latest from the cockpit api.
+
+```
+USAGE
+  $ laioutr rc update [FILENAME] --cockpitApiHost <value> --cwd <value>
+
+FLAGS
+  --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
+  Updates an existing laioutrrc.json file with the latest from the cockpit api.
+
+EXAMPLES
+  $ laioutr rc update
+```
+
+_See code: [src/commands/rc/update.ts](https://github.com/packages/cli/blob/v0.3.0/src/commands/rc/update.ts)_
 <!-- commandsstop -->

package/dist/api/fetchRc.d.ts

@@ -0,0 +1,10 @@
+interface HostApiOptions {
+    cockpitApiHost: string;
+}
+export interface ProjectApiOptions extends HostApiOptions {
+    project: string;
+    projectSecret: string;
+    environmentName: string;
+}
+export declare const fetchRc: (flags: ProjectApiOptions) => Promise<string>;
+export {};

package/dist/api/fetchRc.js

@@ -0,0 +1,28 @@
+import { z } from 'zod/v4';
+const apiResponseSchema = z.object({
+    content: z.string(),
+});
+export const fetchRc = async (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) {
+        // eslint-disable-next-line no-console
+        console.error(data);
+        throw new Error('Failed to fetch RC file. See error message above.');
+    }
+    const parsed = apiResponseSchema.parse(data);
+    return parsed.content;
+};

package/dist/commands/{project/fetch-rc.d.ts → rc/fetch.d.ts}

@@ -1,5 +1,5 @@
 import LaioutrBaseCommand from '../../laioutr-base-command.js';
-export default class ProjectFetchRc extends LaioutrBaseCommand {
+export default class ProjectRcFetch extends LaioutrBaseCommand {
     static args: {
         fileName: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
@@ -12,6 +12,7 @@ export default class ProjectFetchRc extends LaioutrBaseCommand {
         cockpitApiHost: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         cwd: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
     };
+    static aliases: string[];
+    static deprecateAliases: boolean;
     run(): Promise<void>;
-    private fetchRc;
 }

package/dist/commands/rc/fetch.js

@@ -0,0 +1,28 @@
+import { writeFile } from 'node:fs/promises';
+import path from 'node:path';
+import { Args, Flags } from '@oclif/core';
+import { fetchRc } from '../../api/fetchRc.js';
+import LaioutrBaseCommand from '../../laioutr-base-command.js';
+export default class ProjectRcFetch 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 }),
+    };
+    static aliases = ['project:fetch-rc'];
+    static deprecateAliases = true;
+    async run() {
+        const { args, flags } = await this.parse(ProjectRcFetch);
+        const rc = await fetchRc(flags);
+        const filePath = path.join(flags.cwd, args.fileName);
+        this.log('Writing RC file', filePath);
+        return writeFile(filePath, rc);
+    }
+}

package/dist/commands/rc/update.d.ts

@@ -0,0 +1,13 @@
+import LaioutrBaseCommand from '../../laioutr-base-command.js';
+export default class ProjectRcUpdate extends LaioutrBaseCommand {
+    static args: {
+        fileName: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    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>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/rc/update.js

@@ -0,0 +1,33 @@
+import { readFile, writeFile } from 'node:fs/promises';
+import path from 'node:path';
+import { Args } from '@oclif/core';
+import { fetchRc } from '../../api/fetchRc.js';
+import LaioutrBaseCommand from '../../laioutr-base-command.js';
+import { rcWithLaioutrMetaSchema } from '../../rc/validation.js';
+export default class ProjectRcUpdate extends LaioutrBaseCommand {
+    static args = {
+        ...LaioutrBaseCommand.args,
+        fileName: Args.string({ default: 'laioutrrc.json', name: 'fileName', required: false }),
+    };
+    static description = 'Updates an existing laioutrrc.json file with the latest from the cockpit api.';
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    static flags = {
+        ...LaioutrBaseCommand.flags,
+    };
+    async run() {
+        const { args, flags } = await this.parse(ProjectRcUpdate);
+        const currentRcRaw = await readFile(path.join(flags.cwd, args.fileName), 'utf-8');
+        const currentRc = rcWithLaioutrMetaSchema.parse(JSON.parse(currentRcRaw));
+        const options = {
+            ...flags,
+            project: currentRc.laioutr.projectSlug,
+            projectSecret: currentRc.laioutr.projectSecretKey,
+            environmentName: currentRc.laioutr.environmentName,
+        };
+        this.log('Fetching latest RC for project', options.project);
+        const rc = await fetchRc(options);
+        const filePath = path.join(flags.cwd, args.fileName);
+        this.log('Writing RC file', filePath);
+        return writeFile(filePath, rc);
+    }
+}

package/dist/rc/validation.d.ts

@@ -0,0 +1,8 @@
+import z from 'zod/v4';
+export declare const rcWithLaioutrMetaSchema: z.ZodObject<{
+    laioutr: z.ZodObject<{
+        projectSecretKey: z.ZodString;
+        projectSlug: z.ZodString;
+        environmentName: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;

package/dist/rc/validation.js

@@ -0,0 +1,8 @@
+import z from 'zod/v4';
+export const rcWithLaioutrMetaSchema = z.object({
+    laioutr: z.object({
+        projectSecretKey: z.string(),
+        projectSlug: z.string(),
+        environmentName: z.string(),
+    }),
+});

package/oclif.manifest.json

@@ -1,7 +1,9 @@
 {
   "commands": {
-    "project:fetch-rc": {
-      "aliases": [],
+    "rc:fetch": {
+      "aliases": [
+        "project:fetch-rc"
+      ],
       "args": {
         "fileName": {
           "default": "laioutrrc.json",
@@ -9,6 +11,7 @@
           "required": false
         }
       },
+      "deprecateAliases": true,
       "description": "Fetches the laioutrrc.json of a project from the cockpit api.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
@@ -68,7 +71,58 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "project:fetch-rc",
+      "id": "rc:fetch",
+      "pluginAlias": "@laioutr/cli",
+      "pluginName": "@laioutr/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "rc",
+        "fetch.js"
+      ]
+    },
+    "rc:update": {
+      "aliases": [],
+      "args": {
+        "fileName": {
+          "default": "laioutrrc.json",
+          "name": "fileName",
+          "required": false
+        }
+      },
+      "description": "Updates an existing laioutrrc.json file with the latest 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"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "rc:update",
       "pluginAlias": "@laioutr/cli",
       "pluginName": "@laioutr/cli",
       "pluginType": "core",
@@ -78,10 +132,10 @@
       "relativePath": [
         "dist",
         "commands",
-        "project",
-        "fetch-rc.js"
+        "rc",
+        "update.js"
       ]
     }
   },
-  "version": "0.2.0"
+  "version": "0.3.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@laioutr/cli",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Laioutr CLI",
   "repository": "packages/cli",
   "author": "Laioutr GmbH",
@@ -54,7 +54,7 @@
     "node": ">=18.0.0"
   },
   "scripts": {
-    "build": "shx rm -rf dist && tsc -b",
+    "build": "shx rm -rf dist && tsc -b && oclif manifest && oclif readme",
     "dev": "./bin/dev.js",
     "lint": "eslint --cache --cache-location ../../.eslintcache",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",

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

@@ -1,52 +0,0 @@
-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;
-    }
-}