n8n-nodes-cliclaw 0.2.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ahmed El-Hadidi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,101 @@
+# n8n-nodes-cliclaw
+
+`n8n-nodes-cliclaw` provides two community nodes for n8n:
+
+- `cliclaw`: connects to a remote host over SSH and runs `codex exec`
+- `cliclaw SSH`: keeps a generic SSH node for command execution and file transfer
+
+The main purpose of this package is to let n8n call Codex CLI on a remote machine where `codex` is already installed and authenticated.
+
+## Installation
+
+### Local installation
+
+```bash
+npm install n8n-nodes-cliclaw
+```
+
+### n8n Community Nodes
+
+1. Open `Settings > Community Nodes`
+2. Select `Install`
+3. Enter `n8n-nodes-cliclaw`
+4. Confirm the installation
+
+## What `cliclaw` does
+
+The `cliclaw` node wraps the Codex CLI command below over SSH:
+
+```bash
+codex exec [options] "your prompt"
+```
+
+It is designed for non-interactive automation. For remote workflows, this is the correct Codex CLI entry point instead of slash commands, because slash commands are intended for interactive sessions.
+
+The node currently exposes these Codex CLI capabilities:
+
+- `--cd`
+- `--model`
+- `--sandbox`
+- `--ask-for-approval`
+- `--json`
+- `--image`
+- `--output-last-message`
+- extra raw arguments
+
+## Remote host prerequisites
+
+The SSH target machine should already have:
+
+1. `codex` installed and available in `PATH`, or an absolute binary path you can provide
+2. valid Codex authentication on that host
+3. permission to access the remote working directory and any remote image paths you pass in
+
+Each SSH credential now includes a `Remote OS` single-select field:
+
+- `Linux`
+- `macOS`
+- `Windows`
+
+The node uses this to wrap the remote command correctly before calling Codex CLI:
+
+- Linux and macOS: `bash -lc 'export PATH="$HOME/.local/bin:$PATH" && codex exec ...'`
+- Windows: `powershell -NoProfile -Command 'codex exec ...'`
+
+## Example
+
+Use the `cliclaw` node with:
+
+- `Host`: your remote server
+- `Username`: your SSH user
+- `Codex Binary`: `codex`
+- `Remote Working Directory`: `/srv/project`
+- `Prompt`: `Review the repo and fix the failing tests`
+- `JSON Output`: enabled
+
+The node returns:
+
+- `stdout`
+- `stderr`
+- `exitCode`
+- `success`
+- `command`
+- `parsedStdout` when stdout is valid JSON
+
+## Generic SSH node
+
+`cliclaw SSH` is still available when you need plain SSH commands, uploads, or downloads outside Codex CLI usage.
+
+## Development
+
+```bash
+pnpm install
+pnpm build
+pnpm lint
+```
+
+## References
+
+- [Codex CLI reference](https://developers.openai.com/codex/cli/reference)
+- [Codex CLI slash commands](https://developers.openai.com/codex/cli/slash-commands)
+- [Codex CLI features](https://developers.openai.com/codex/cli/features#image-generation)

package/dist/credentials/ExampleCredentialsApi.credentials.d.ts

@@ -0,0 +1,8 @@
+import { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class ExampleCredentialsApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/ExampleCredentialsApi.credentials.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExampleCredentialsApi = void 0;
+class ExampleCredentialsApi {
+    constructor() {
+        this.name = 'exampleCredentialsApi';
+        this.displayName = 'Example Credentials API';
+        this.properties = [
+            {
+                displayName: 'User Name',
+                name: 'username',
+                type: 'string',
+                default: '',
+            },
+            {
+                displayName: 'Password',
+                name: 'password',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                auth: {
+                    username: '={{ $credentials.username }}',
+                    password: '={{ $credentials.password }}',
+                },
+                qs: {
+                    n8n: 'rocks',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: 'https://example.com/',
+                url: '',
+            },
+        };
+    }
+}
+exports.ExampleCredentialsApi = ExampleCredentialsApi;
+//# sourceMappingURL=ExampleCredentialsApi.credentials.js.map

package/dist/credentials/ExampleCredentialsApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleCredentialsApi.credentials.js","sourceRoot":"","sources":["../../credentials/ExampleCredentialsApi.credentials.ts"],"names":[],"mappings":";;;AAOA,MAAa,qBAAqB;IAAlC;QACC,SAAI,GAAG,uBAAuB,CAAC;QAC/B,gBAAW,GAAG,yBAAyB,CAAC;QACxC,eAAU,GAAsB;YAI/B;gBACC,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aACX;YACD;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;aACX;SACD,CAAC;QAKF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,IAAI,EAAE;oBACL,QAAQ,EAAE,8BAA8B;oBACxC,QAAQ,EAAE,8BAA8B;iBACxC;gBACD,EAAE,EAAE;oBAEH,GAAG,EAAE,OAAO;iBACZ;aACD;SACD,CAAC;QAGF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,sBAAsB;gBAC/B,GAAG,EAAE,EAAE;aACP;SACD,CAAC;IACH,CAAC;CAAA;AAhDD,sDAgDC"}

package/dist/credentials/SshPasswordApi.credentials.d.ts

@@ -0,0 +1,7 @@
+import type { ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class SshPasswordApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+}

package/dist/credentials/SshPasswordApi.credentials.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SshPasswordApi = void 0;
+class SshPasswordApi {
+    constructor() {
+        this.name = 'sshPasswordApi';
+        this.displayName = 'SSH Password';
+        this.documentationUrl = 'https://docs.n8n.io/integrations/builtin/credentials/ssh/';
+        this.properties = [
+            {
+                displayName: 'Host',
+                name: 'host',
+                required: true,
+                type: 'string',
+                default: '',
+                placeholder: 'localhost',
+            },
+            {
+                displayName: 'Port',
+                name: 'port',
+                required: true,
+                type: 'number',
+                default: 22,
+            },
+            {
+                displayName: 'Username',
+                name: 'username',
+                type: 'string',
+                default: '',
+            },
+            {
+                displayName: 'Password',
+                name: 'password',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+            },
+            {
+                displayName: 'Remote OS',
+                name: 'remoteOs',
+                type: 'options',
+                default: 'linux',
+                options: [
+                    {
+                        name: 'Linux',
+                        value: 'linux',
+                    },
+                    {
+                        name: 'macOS',
+                        value: 'macos',
+                    },
+                    {
+                        name: 'Windows',
+                        value: 'windows',
+                    },
+                ],
+                description: 'Operating system of the remote host so the node can preload the right shell command',
+            },
+        ];
+    }
+}
+exports.SshPasswordApi = SshPasswordApi;
+//# sourceMappingURL=SshPasswordApi.credentials.js.map

package/dist/credentials/SshPasswordApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SshPasswordApi.credentials.js","sourceRoot":"","sources":["../../credentials/SshPasswordApi.credentials.ts"],"names":[],"mappings":";;;AAEA,MAAa,cAAc;IAA3B;QACQ,SAAI,GAAG,gBAAgB,CAAC;QAExB,gBAAW,GAAG,cAAc,CAAC;QAE7B,qBAAgB,GAAG,2DAA2D,CAAC;QAE/E,eAAU,GAAsB;YACxB;gBACQ,WAAW,EAAE,MAAM;gBACnB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,WAAW;aAC/B;YACD;gBACQ,WAAW,EAAE,MAAM;gBACnB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aAClB;YACD;gBACQ,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aAClB;YACD;gBACQ,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACL,QAAQ,EAAE,IAAI;iBACrB;gBACD,OAAO,EAAE,EAAE;aAClB;YACD;gBACQ,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,OAAO;gBAChB,OAAO,EAAE;oBACD;wBACQ,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,OAAO;qBACrB;oBACD;wBACQ,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,OAAO;qBACrB;oBACD;wBACQ,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,SAAS;qBACvB;iBACR;gBACD,WAAW,EAAE,qFAAqF;aACzG;SACR,CAAC;IACV,CAAC;CAAA;AA5DD,wCA4DC"}

package/dist/credentials/SshPrivateKeyApi.credentials.d.ts

@@ -0,0 +1,7 @@
+import type { ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class SshPrivateKeyApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+}

package/dist/credentials/SshPrivateKeyApi.credentials.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SshPrivateKeyApi = void 0;
+class SshPrivateKeyApi {
+    constructor() {
+        this.name = 'sshPrivateKeyApi';
+        this.displayName = 'SSH Private Key';
+        this.documentationUrl = 'https://docs.n8n.io/integrations/builtin/credentials/ssh/';
+        this.properties = [
+            {
+                displayName: 'Host',
+                name: 'host',
+                required: true,
+                type: 'string',
+                default: '',
+                placeholder: 'localhost',
+            },
+            {
+                displayName: 'Port',
+                name: 'port',
+                required: true,
+                type: 'number',
+                default: 22,
+            },
+            {
+                displayName: 'Username',
+                name: 'username',
+                type: 'string',
+                default: '',
+            },
+            {
+                displayName: 'Private Key',
+                name: 'privateKey',
+                type: 'string',
+                typeOptions: {
+                    rows: 4,
+                    password: true,
+                },
+                default: '',
+            },
+            {
+                displayName: 'Passphrase',
+                name: 'passphrase',
+                type: 'string',
+                default: '',
+                description: 'Passphase used to create the key, if no passphase was used leave empty',
+                typeOptions: { password: true },
+            },
+            {
+                displayName: 'Remote OS',
+                name: 'remoteOs',
+                type: 'options',
+                default: 'linux',
+                options: [
+                    {
+                        name: 'Linux',
+                        value: 'linux',
+                    },
+                    {
+                        name: 'macOS',
+                        value: 'macos',
+                    },
+                    {
+                        name: 'Windows',
+                        value: 'windows',
+                    },
+                ],
+                description: 'Operating system of the remote host so the node can preload the right shell command',
+            },
+        ];
+    }
+}
+exports.SshPrivateKeyApi = SshPrivateKeyApi;
+//# sourceMappingURL=SshPrivateKeyApi.credentials.js.map

package/dist/credentials/SshPrivateKeyApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SshPrivateKeyApi.credentials.js","sourceRoot":"","sources":["../../credentials/SshPrivateKeyApi.credentials.ts"],"names":[],"mappings":";;;AAEA,MAAa,gBAAgB;IAA7B;QACQ,SAAI,GAAG,kBAAkB,CAAC;QAE1B,gBAAW,GAAG,iBAAiB,CAAC;QAEhC,qBAAgB,GAAG,2DAA2D,CAAC;QAE/E,eAAU,GAAsB;YACxB;gBACQ,WAAW,EAAE,MAAM;gBACnB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,WAAW;aAC/B;YACD;gBACQ,WAAW,EAAE,MAAM;gBACnB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aAClB;YACD;gBACQ,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aAClB;YACD;gBACQ,WAAW,EAAE,aAAa;gBAC1B,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACL,IAAI,EAAE,CAAC;oBACP,QAAQ,EAAE,IAAI;iBACrB;gBACD,OAAO,EAAE,EAAE;aAClB;YACD;gBACQ,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,wEAAwE;gBACrF,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;aACtC;YACD;gBACQ,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,OAAO;gBAChB,OAAO,EAAE;oBACD;wBACQ,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,OAAO;qBACrB;oBACD;wBACQ,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,OAAO;qBACrB;oBACD;wBACQ,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,SAAS;qBACvB;iBACR;gBACD,WAAW,EAAE,qFAAqF;aACzG;SACR,CAAC;IACV,CAAC;CAAA;AArED,4CAqEC"}

package/dist/nodes/Cliclaw/Cliclaw.node.d.ts

@@ -0,0 +1,12 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+interface IExtendedNodeTypeDescription extends INodeTypeDescription {
+    usableAsTool?: boolean;
+}
+export declare class Cliclaw implements INodeType {
+    description: IExtendedNodeTypeDescription;
+    methods: {
+        loadOptions: {};
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+export {};