minor update

AdeboyeDN · AdeboyeDN · commit c1fb44509176 · 2023-07-17T10:31:34.000+01:00
diff --git a/bin/LICENSE b/bin/LICENSE
diff --git a/bin/README.md b/bin/README.md
@@ -0,0 +1,66 @@
+# Gitsecure CLI
+
+Gitsecure CLI is a cutting-edge SecretOps infrastructure designed for developers and teams.
+
+## Useful links
+
+- [Github repository](git@github.com:GitsecureHQ/gitsecure-cli.git)
+- [Project documentation](https://mirage-collarbone-cf7.notion.site/GitSecure-Model-Structure-c610f335aa07401db311ff44fe4a8758)
+
+## Requirements
+
+- Go version 1.19 or higher
+- Cobra version 1.6.1
+
+## Running the application
+
+To run the CLI, follow the steps below:
+
+```sh
+ # Build the CLI Locally
+ $ go build
+ # Install the CLI after the build 
+ $ go install 
+```
+
+## Contributing
+
+To contribute to Gitsecure CLI, please follow these steps:
+
+1. Pick an issue from the [GitHub repository](https://github.com/GitsecureHQ/gitsecure-cli).
+2. Clone the repository using the following command:
+
+```sh
+ $ git clone https://github.com/GitsecureHQ/gitsecure-cli
+```
+
+3. When creating a new branch, use the following naming convention: `GSC-<issue-no>-<short-description>`, for example, `GSC-1-project-setup`. The main branch should be based on `develop`.
+4. When creating a pull request, select `develop` as the target branch.
+
+## Pushing changes to the repository
+
+Use the following commands to push changes to the repository:
+
+```sh
+# if pushing for the first time
+$ git push -u origin <branchname>
+
+# if pushing normally
+$ git push
+```
+## Install the CLI
+```
+# Scoop For Windows 
+
+$ scoop bucket add gitsecurehq https://github.com/GitsecureHQ/scoop-gitsecure
+$ scoop install gitsecure-cli
+$ gitsecure --version
+
+# Brew For Mac And Linux Users
+
+$ brew tap GitsecureHQ/brew
+$ brew install gitsecure
+$ gitsecure --version
+```
+
+
diff --git a/bin/gitsecure.js b/bin/gitsecure.js
@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+import { execFileSync } from "child_process";
+import path from "path";
+import { exit } from "process";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const binName =
+  process.platform === "win32" ? "gitsecure.exe" : "gitsecure";
+try {
+  execFileSync(path.resolve(`${__dirname}/${binName}`), process.argv.slice(2), {
+    stdio: "inherit",
+  });
+} catch (e) {
+  exit(1);
+}
diff --git a/npm-install/config.js b/npm-install/config.js
@@ -0,0 +1,30 @@
+/**
+ * Global configuration
+ */
+export const CONFIG = {
+    /**
+     * The name of the binary
+     * @type {string}
+     */
+    name: "gitsecure",
+  
+    /**
+     * Where to save the unzipped files
+     * @type {string}
+     */
+    path: "./bin",
+  
+    /**
+     * The URL to download the binary form
+     *
+     * - `{{arch}}` is one of the Golang achitectures listed below
+     * - `{{bin_name}}` is the name declared above
+     * - `{{platform}}` is one of the Golang platforms listed below
+     * - `{{version}}` is the version number as `0.0.0` (taken from package.json)
+     *
+     * @type {string}
+     */
+    url: "https://github.com/GitsecureHQ/gitsecure-cli/releases/download/v{{version}}/{{bin_name}}_v{{version}}_{{triple}}.tar.gz",
+  };
+
+  
diff --git a/npm-install/getReleaseInfo.js b/npm-install/getReleaseInfo.js
@@ -0,0 +1,56 @@
+import * as fs from "fs/promises";
+import os from "os";
+
+function getSystemInfo() {
+  const type = os.type();
+  const arch = os.arch();
+  if (type === "Windows_NT" && arch === "x64") {
+    return {
+      platform: "Windows",
+      arch: "x86_64",
+    };
+  }
+  if (type === "Windows_NT") {
+    return {
+      platform: "Windows",
+      arch: "i386",
+    };
+  }
+  if (type === "Linux" && arch === "x64") {
+    return {
+      platform: "Linux",
+      arch: "arm64",
+    };
+  }
+  if (type === "Linux" && arch === "x32") {
+    return {
+      platform: "Linux",
+      arch: "i386",
+    };
+  }
+  if (type === "Darwin" && arch === "x64") {
+    return {
+      platform: "Darwin",
+      arch: "x64",
+    };
+  }
+  if (type === "Darwin" && arch === "arm64") {
+    return {
+      platform: "Darwin",
+      arch: "arm64",
+    };
+  }
+
+  throw new Error(`Unsupported platform: ${type} ${arch}`);
+}
+
+async function getReleaseInfo() {
+  const { platform, arch } = getSystemInfo();
+  const packageJson = await fs.readFile("package.json").then(JSON.parse);
+  let version = packageJson.version;
+  const url = `https://github.com/GitsecureHQ/gitsecure-cli/releases/download/v${version}/gitsecure-cli_${version}_${platform}_${arch}.tar.gz`;
+  const name = "gitsecure-cli";
+  return { url, name };
+}
+
+export default getReleaseInfo;
diff --git a/npm-install/postinstall.js b/npm-install/postinstall.js
@@ -0,0 +1,45 @@
+import { createWriteStream } from "fs";
+import * as fs from "fs/promises";
+import fetch from "node-fetch";
+import { pipeline } from "stream/promises";
+import tar from "tar";
+
+import { CONFIG } from "./config.js";
+import getReleaseInfo from "./getReleaseInfo.js";
+
+async function install() {
+  const packageJson = await fs.readFile("package.json").then(JSON.parse);
+  let version = packageJson.version;
+
+  if (typeof version !== "string") {
+    throw new Error("Missing version in package.json");
+  }
+
+  if (version[0] === "v") version = version.slice(1);
+
+  // Fetch Static Config
+  let { name: binName, path: binPath } = CONFIG;
+  const { url } = await getReleaseInfo();
+  console.log(url);
+  const response = await fetch(url);
+  if (!response.ok) {
+    throw new Error("Failed fetching the binary: " + response.statusText);
+  }
+
+  const tarFile = "downloaded.tar.gz";
+
+  await fs.mkdir(binPath, { recursive: true });
+  await pipeline(response.body, createWriteStream(tarFile));
+  await tar.x({ file: tarFile, cwd: binPath });
+  await fs.rm(tarFile);
+}
+
+install()
+  .then(async () => {
+    process.exit(0);
+  })
+  .catch(async (err) => {
+    console.error(err);
+    process.exit(1);
+  });
+  
diff --git a/package.json b/package.json
@@ -1,11 +1,14 @@
 {
   "name": "@gitsecure/cli",
-  "version": "0.0.0",
+  "version": "0.1.2",
   "description": "Modern SecretOps infrastructure for developers and teams.",
   "main": "index.js",
+  "type": "module",
+  "engines": {
+    "node": ">=16.0.0"
+  },
   "scripts": {
-    "postinstall": "go-npm install",
-    "preuninstall": "go-npm uninstall"
+    "postinstall": "node ./npm-install/postinstall.js"
   },
   "repository": {
     "type": "git",
@@ -21,14 +24,16 @@
     "url": "https://github.com/GitsecureHQ/gitsecure-cli/issues"
   },
   "homepage": "https://github.com/GitsecureHQ/gitsecure-cli#readme",
+  "devDependencies": {},
   "dependencies": {
-    "@gitsecure/cli": "^1.0.0",
-    "global": "^4.4.0",
-    "go-npm": "^0.1.9"
+    "node-fetch": "^3.1.0",
+    "tar": "^6.1.11"
   },
-  "goBinary": {
-    "name": "gitsecure",
-    "path": "./bin",
-    "url": "https://github.com/GitsecureHQ/gitsecure-cli/releases/download/v{{version}}/simp-cli_v{{version}}-SNAPSHOT_{{platform}}_{{arch}}.tar.gz"
+  "files": [
+    "npm-install",
+    "README.md"
+  ],
+  "bin": {
+    "gitsecure-cli": "bin/gitsecure.js"
   }
 }
