ns-gm 1.0.3 → 1.0.5

package/README.md

@@ -1,12 +1,11 @@
-# ns-gm
+# ns-gm (NetSuite God Mode CLI)
 
-NetSuite CLI for running SuiteScript snippets and fetching logs through a local proxy + RESTlet.
+NetSuite CLI for running SuiteScript snippets, files and fetching logs through a local proxy + RESTlet.
 
 ## Install
 
 ```bash
-npm install
-npm link
+npm i -g ns-gm
 ```
 
 Then use:
@@ -15,6 +14,13 @@ Then use:
 ns-gm --help
 ```
 
+For local development from source:
+
+```bash
+npm install
+npm link
+```
+
 ## NetSuite Setup (OAuth 2.0 M2M)
 
 ### 1) Integration Record
@@ -44,7 +50,7 @@ After saving, copy:
 Generate keypair (PowerShell example):
 
 ```powershell
-$dir = "C:\Users\simos\Documents\ns-gm-certs"
+$dir = "C:\Users\user\Documents\ns-gm-certs"
 New-Item -ItemType Directory -Force -Path $dir | Out-Null
 openssl req -new -x509 -nodes -days 365 -newkey rsa:4096 -keyout "$dir\private_key.pem" -out "$dir\public_key.pem" -subj "/CN=ns-gm-oauth"
 ```
@@ -74,7 +80,7 @@ Setup is alias-based. It lets you pick an existing alias or create `new`.
 - `accountId`: `1234567_SB1`
 - `clientId`: `6f8d...` (OAuth 2.0 Client ID from integration record)
 - `certificateId`: `custcertificate_oauth2_prod` (kid from M2M mapping)
-- `privateKeyPath`: `C:\Users\simos\Documents\ns-gm-certs\private_key.pem`
+- `privateKeyPath`: `C:\Users\user\Documents\ns-gm-certs\private_key.pem`
 - `restletUrl`: `https://1234567-sb1.restlets.api.netsuite.com/app/site/hosting/restlet.nl?script=customscript_ns_gm_restlet&deploy=1`
 - `scope`: `restlets`
 
@@ -84,6 +90,34 @@ Show active profile/config:
 ns-gm setup --show
 ```
 
+## Non-interactive Setup (CI/Sandbox)
+
+Use `setup:ci` for headless environments. This command upserts a profile alias and sets it active.
+
+```bash
+ns-gm setup:ci \
+  --alias prod-main \
+  --account 1234567_SB1 \
+  --clientid 6f8d... \
+  --certificateid custcertificate_oauth2_prod \
+  --privatekeypath C:\Users\user\Documents\ns-gm-certs\private_key.pem \
+  --restleturl "https://1234567-sb1.restlets.api.netsuite.com/app/site/hosting/restlet.nl?script=customscript_ns_gm_restlet&deploy=1" \
+  --scope restlets
+```
+
+Required flags:
+
+- `--alias`
+- `--account`
+- `--clientid`
+- `--certificateid`
+- `--privatekeypath`
+- `--restleturl`
+
+Optional flags:
+
+- `--scope` (defaults to `restlets`)
+
 Credentials are stored at:
 
 `~/.ns-gm/credentials.json`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ns-gm",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "CLI tool for executing SuiteScript code against NetSuite",
   "main": "src/cli.js",
   "bin": {
@@ -21,7 +21,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/Project-X-Innovation/ns-gm"
+    "url": "git+https://github.com/Project-X-Innovation/ns-gm.git"
   },
   "homepage": "https://github.com/Project-X-Innovation/ns-gm#readme",
   "bugs": {
@@ -50,4 +50,4 @@
   "engines": {
     "node": ">=24.0.0"
   }
-}
+}

package/src/cli.js

@@ -8,6 +8,7 @@ const envCommand = require('./commands/env');
 const logsCommand = require('./commands/logs');
 const stopCommand = require('./commands/stop');
 const setupCommand = require('./commands/setup');
+const setupCiCommand = require('./commands/setup-ci');
 const helpCommand = require('./commands/help');
 
 const program = new Command();
@@ -62,6 +63,19 @@ program
     .option('--show', 'Show current configuration (secrets masked)')
     .action(setupCommand);
 
+// Setup CI command - Non-interactive credential configuration
+program
+    .command('setup:ci')
+    .description('Non-interactive credential configuration for CI/sandbox')
+    .option('--alias <alias>', 'Profile alias to create/update and activate')
+    .option('--account <accountId>', 'NetSuite Account ID')
+    .option('--clientid <clientId>', 'OAuth 2.0 Client ID')
+    .option('--certificateid <certificateId>', 'Certificate ID (kid)')
+    .option('--privatekeypath <path>', 'Private key path (.pem)')
+    .option('--restleturl <url>', 'RESTlet URL')
+    .option('--scope <scope>', 'OAuth scope (defaults to restlets)')
+    .action(setupCiCommand);
+
 // Help command - Show command documentation
 program
     .command('help [command]')

package/src/commands/help.js

@@ -112,12 +112,37 @@ const helpData = {
                 "Private key material is not stored in the credentials file"
             ]
         },
+        'setup:ci': {
+            brief: "Non-interactive credential configuration for CI/sandbox",
+            syntax: "ns-gm setup:ci --alias <alias> --account <accountId> --clientid <clientId> --certificateid <certificateId> --privatekeypath <path> --restleturl <url> [--scope <scope>]",
+            description: "Non-interactive setup for CI/sandbox usage. Upserts the specified alias profile and sets it as the active profile in ~/.ns-gm/credentials.json.",
+            options: [
+                { flag: "--alias <alias>", description: "Profile alias to create/update and set active" },
+                { flag: "--account <accountId>", description: "NetSuite account ID" },
+                { flag: "--clientid <clientId>", description: "OAuth 2.0 client ID" },
+                { flag: "--certificateid <certificateId>", description: "Certificate ID (kid)" },
+                { flag: "--privatekeypath <path>", description: "Path to private key PEM file" },
+                { flag: "--restleturl <url>", description: "Deployed RESTlet URL" },
+                { flag: "--scope <scope>", description: "OAuth scope (defaults to restlets)" }
+            ],
+            examples: [
+                "ns-gm setup:ci --alias prod-main --account 1234567_SB1 --clientid abc123 --certificateid custcertificate_oauth2_prod --privatekeypath ./private_key.pem --restleturl \"https://1234567-sb1.restlets.api.netsuite.com/app/site/hosting/restlet.nl?script=customscript_ns_gm_restlet&deploy=1\"",
+                "ns-gm setup:ci --alias prod-main --account 1234567_SB1 --clientid abc123 --certificateid custcertificate_oauth2_prod --privatekeypath ./private_key.pem --restleturl \"https://1234567-sb1.restlets.api.netsuite.com/app/site/hosting/restlet.nl?script=customscript_ns_gm_restlet&deploy=1\" --scope restlets"
+            ],
+            clarifications: [
+                "All setup flags except --scope are required",
+                "Profile alias is upserted (create or overwrite) by alias name",
+                "Successful command always sets the alias as active",
+                "Private key path must exist on disk when command runs",
+                "RESTlet URL must include /app/site/hosting/restlet.nl and query params"
+            ]
+        },
         help: {
             brief: "Show help information for commands",
             syntax: "ns-gm help [command] [options]",
             description: "Displays help information for all commands or a specific command. Output format can be JSON (default, for AI agents) or plain text (for humans).",
             options: [
-                { flag: "[command]", description: "Optional command name to get detailed help for (init, run, env, logs, stop, setup)" },
+                { flag: "[command]", description: "Optional command name to get detailed help for (init, run, env, logs, stop, setup, setup:ci)" },
                 { flag: "--format <format>", description: "Output format: json (default) or text" }
             ],
             examples: [

package/src/commands/setup-ci.js

@@ -0,0 +1,65 @@
+const fs = require('fs');
+const path = require('path');
+const { EXIT_CODES, exitWithCode } = require('../utils/exitCodes');
+const {
+    saveProfile,
+    setActiveAlias,
+    STORE_PATH
+} = require('../utils/profileStore');
+
+const RESTLET_URL_REGEX = /^https:\/\/.+\/app\/site\/hosting\/restlet\.nl\?.+/;
+
+function requireTrimmedValue(value, label) {
+    if (typeof value !== 'string' || value.trim().length === 0) {
+        exitWithCode(EXIT_CODES.VALIDATION_ERROR, `${label} is required`);
+    }
+    return value.trim();
+}
+
+function resolveAndValidatePrivateKeyPath(privateKeyPathInput) {
+    const resolvedPath = path.resolve(privateKeyPathInput.trim());
+    if (!fs.existsSync(resolvedPath)) {
+        exitWithCode(EXIT_CODES.VALIDATION_ERROR, `File does not exist: ${resolvedPath}`);
+    }
+    return resolvedPath;
+}
+
+function validateRestletUrl(restletUrl) {
+    if (!RESTLET_URL_REGEX.test(restletUrl)) {
+        exitWithCode(EXIT_CODES.VALIDATION_ERROR, 'Invalid RESTlet URL');
+    }
+}
+
+async function setupCiCommand(options) {
+    try {
+        const alias = requireTrimmedValue(options.alias, 'Alias');
+        const accountId = requireTrimmedValue(options.account, 'Account ID');
+        const clientId = requireTrimmedValue(options.clientid, 'Client ID');
+        const certificateId = requireTrimmedValue(options.certificateid, 'Certificate ID');
+        const privateKeyPathInput = requireTrimmedValue(options.privatekeypath, 'Private key path');
+        const restletUrl = requireTrimmedValue(options.restleturl, 'RESTlet URL');
+        const scopeInput = typeof options.scope === 'string' ? options.scope.trim() : '';
+
+        const privateKeyPath = resolveAndValidatePrivateKeyPath(privateKeyPathInput);
+        validateRestletUrl(restletUrl);
+
+        const profile = {
+            accountId,
+            clientId,
+            certificateId,
+            privateKeyPath,
+            restletUrl,
+            scope: scopeInput || 'restlets'
+        };
+
+        saveProfile(alias, profile);
+        setActiveAlias(alias);
+
+        console.log(`Saved profile "${alias}" and set it as active.`);
+        console.log(`Credentials store: ${STORE_PATH}`);
+    } catch (error) {
+        exitWithCode(EXIT_CODES.GENERAL_ERROR, `Setup CI error: ${error.message}`);
+    }
+}
+
+module.exports = setupCiCommand;