docs: added requires in README.md

Author: ZhiXiao-Lin

README.md

@@ -2,6 +2,65 @@
 
 Node wrapper for nerdctl
 
+# Requires
+
+## macOS
+
+```shell
+# Install Homebrew
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+
+# Install Lima
+brew install lima
+```
+
+## Windows
+
+```shell
+# Installing WSL GuestOS on PowerShell
+wsl --install -d Ubuntu-20.04
+
+# Set user and password
+# Keep up to date
+sudo apt update && sudo apt upgrade -y
+
+# Add distrod to the GuestOS
+curl -L -O "https://raw.githubusercontent.com/nullpo-head/wsl-distrod/main/install.sh"
+chmod +x install.sh
+sudo ./install.sh install
+
+# Enable systemd
+sudo /opt/distrod/bin/distrod enable
+# Enable systemd and let it start as Windows starts
+sudo /opt/distrod/bin/distrod enable --start-on-windows-boot
+
+# Restart WSL
+exit
+wsl -t Ubuntu-20.04
+wsl -d Ubuntu-20.04
+pgrep system -a
+
+# Install additional required packages
+sudo apt install -y uidmap fuse-overlayfs
+
+# Allow systemctl to run as rootless and put it in runtime path
+sudo loginctl enable-linger $(id -un)
+ls /run/user/$(id -u)
+export XDG_RUNTIME_DIR=/run/user/$(id -u)
+
+# Install Nerdctl and Containerd
+cd ~/
+mkdir .local
+cd .local/
+wget https://github.com/containerd/nerdctl/releases/download/v0.15.0/nerdctl-full-0.15.0-linux-amd64.tar.gz
+tar xfz nerdctl-full-0.15.0-linux-amd64.tar.gz
+cd ~/
+# Run the installer through the path of the bin directory
+export PATH=$HOME/.local/bin:$PATH
+containerd-rootless-setuptool.sh install
+pgrep contain -a
+```
+
 # Install
 
 ```shell
@@ -14,6 +73,10 @@ yarn add nerdctl
 import { factory } from "nerdctl";
 
 const engine = factory();
+
+await engine.initVM();
+await engine.startVM();
+
 const IMAGE = "hello-world";
 
 await engine.pullImage(IMAGE);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nerdctl",
-  "version": "0.1.4",
+  "version": "0.1.9",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "description": "Node wrapper for nerdctl",

src/index.ts

@@ -1,5 +1,3 @@
-import { ChildProcess, exec } from "child_process";
-
 import BaseBackend from "@/vms/base";
 import LimaBackend from "@/vms/lima";
 import WslBackend from "@/vms/wsl";
@@ -25,13 +23,17 @@ export function factory(
 
 async function test() {
   const vm = factory("wsl -u vmenv");
-  const images = await vm.getImages();
-  console.log(images);
-  await vm.pullImage("hello-world");
-
-  const container = await vm.run('hello-world', { detach: true });
-
-  vm.
+  console.log(await vm.getImages());
+  const child = await vm.pullImage("hello-world");
+  await new Promise((resolve, reject) => {
+    child.stderr?.on("data", (data) => {
+      console.log(data);
+    });
+    child.stdout?.on("close", () => {
+      resolve(true);
+    });
+  });
+  console.log(await vm.getImages());
 }
 
 test();

src/types/container.ts

@@ -69,7 +69,7 @@ export interface StopCommandFlags extends GlobalFlags {
   time?: string;
 }
 
-export interface RmCommandFlags extends GlobalFlags {
+export interface RemoveCommandFlags extends GlobalFlags {
   force?: boolean;
   volumes?: boolean;
 }

src/types/images.ts

@@ -1,3 +1,5 @@
+import { GlobalFlags } from "./global";
+
 export interface ImageResult {
   CreatedAt: string;
   CreatedSince: string;
@@ -9,3 +11,8 @@ export interface ImageResult {
   BlobSize: string;
   Platform: string;
 }
+
+export interface RemoveImageCommandFlags extends GlobalFlags {
+  async?: boolean;
+  force?: boolean;
+}

src/vms/base.ts

@@ -1,15 +1,15 @@
 import { Architecture, ExecResult } from "@/types";
 import { ExecOptions, ShellString, exec } from "shelljs";
+import { ImageResult, RemoveImageCommandFlags } from "@/types/images";
 import {
   LogsCommandFlags,
-  RmCommandFlags,
+  RemoveCommandFlags,
   RunCommandFlags,
   StopCommandFlags,
 } from "@/types/container";
 
 import { ChildProcess } from "child_process";
 import { GlobalFlags } from "@/types/global";
-import { ImageResult } from "@/types/images";
 import { LoginCommandFlags } from "@/types/registry";
 import { paramCase } from "change-case";
 import { platform } from "@/utils";
@@ -90,6 +90,12 @@ export default abstract class BaseBackend {
 
     return (await this.exec(command, { async: false })) as ShellString;
   }
+
+  async logout(server?: string): Promise<ShellString> {
+    const command = `${this.container} logout ${server}`;
+
+    return (await this.exec(command, { async: false })) as ShellString;
+  }
   //#endregion
 
   //#region containers
@@ -113,7 +119,7 @@ export default abstract class BaseBackend {
 
   async remove(
     container: string | string[],
-    flags?: RmCommandFlags
+    flags?: RemoveCommandFlags
   ): Promise<ShellString> {
     const containers = Array.isArray(container)
       ? container.join(" ")
@@ -159,5 +165,17 @@ export default abstract class BaseBackend {
       });
     });
   }
+
+  async removeImage(
+    image: string | string[],
+    flags?: RemoveImageCommandFlags
+  ): Promise<ShellString> {
+    const images = Array.isArray(image) ? image.join(" ") : image;
+
+    return (await this.exec(
+      `${this.container} rmi ${this.mergeFlags(flags)} ${images}`,
+      { async: false }
+    )) as ShellString;
+  }
   //#endregion
 }

src/vms/lima.ts

@@ -1,13 +1,15 @@
 import BaseBackend from "./base";
 import { ChildProcess } from "child_process";
 import { LimaListResult } from "@/types/lima";
+import { isM1 } from "@/utils";
 import { which } from "shelljs";
 
 export default class LimaBackend extends BaseBackend {
   async initVM(): Promise<boolean> {
     if (!which("brew")) return false;
     if (!which(this.vm)) {
-      const child = (await this.exec(`brew install lima`)) as ChildProcess;
+      const command = `${isM1 ? `arch -arm64 ` : ""}brew install lima`;
+      const child = (await this.exec(command)) as ChildProcess;
       await new Promise((resolve, reject) => {
         child?.stdout?.on("data", (data) => {
           console.log(data);

src/vms/wsl.ts

@@ -14,7 +14,6 @@ export default class WslBackend extends BaseBackend {
 
   async initVM(): Promise<boolean> {
     if (!which("wsl")) return false;
-    if (!which(this.runtime)) return false;
     return true;
   }