JS-based command line tool (WIP)

codegen/package.json

@@ -8,7 +8,6 @@
         "clean": "matter-build clean",
         "build": "matter-build",
         "build-clean": "matter-build --clean",
-        "console": "matter-run bin/repl.ts",
         "generate-spec": "matter-run bin/generate-spec.js",
         "generate-chip": "matter-run bin/generate-chip.js",
         "generate-model": "matter-run bin/generate-model.js",
@@ -33,9 +32,9 @@
     "homepage": "https://github.com/project-chip/matter.js#readme",
     "dependencies": {
         "@matter/general": "*",
+        "@matter/intermediate-models": "*",
         "@matter/model": "*",
-        "@matter/tools": "*",
-        "@matter/intermediate-models": "*"
+        "@matter/tools": "*"
     },
     "devDependencies": {
         "@types/jsdom": "^21.1.6",

codegen/src/tsconfig.json

@@ -10,10 +10,10 @@
             "path": "../../packages/general/src"
         },
         {
-            "path": "../../packages/model/src"
+            "path": "../../models/src"
         },
         {
-            "path": "../../models/src"
+            "path": "../../packages/model/src"
         }
     ]
 }

models/package.json

@@ -34,7 +34,7 @@
     },
     "homepage": "https://github.com/project-chip/matter.js#readme",
     "devDependencies": {
-        "@matter/tools": "*",
-        "@matter/model": "*"
+        "@matter/model": "*",
+        "@matter/tools": "*"
     }
 }

package.json

@@ -15,6 +15,7 @@
     "packages/nodejs-shell",
     "packages/examples",
     "packages/react-native",
+    "packages/cli-tool",
     "models",
     "codegen",
     "chip-testing",
@@ -40,7 +41,7 @@
     "matter-multidevice": "matter-run packages/examples/src/examples/MultiDeviceNode.ts",
     "matter-controller": "matter-run packages/examples/src/examples/ControllerNode.ts",
     "shell": "matter-run packages/nodejs-shell/src/app.ts"
-},
+  },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^7.16.1",
     "@typescript-eslint/parser": "^7.18.0",

packages/cli-tool/README.md

@@ -0,0 +1 @@
+A matter.js-based command line utility for interacting with Matter.

packages/cli-tool/bin/matter.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env matter-run
+import { main } from "../dist/esm/cli.js";
+await main(process.argv);

packages/cli-tool/package.json

@@ -0,0 +1,69 @@
+{
+    "name": "@matter/cli-tool",
+    "version": "0.0.0-git",
+    "description": "Command line tool for interacting with Matter",
+    "keywords": [
+        "iot",
+        "home automation",
+        "matter",
+        "smart device"
+    ],
+    "license": "Apache-2.0",
+    "author": "matter.js authors",
+    "contributors": [
+        "Greg Lauckhart <[email protected]>"
+    ],
+    "bugs": {
+        "url": "https://github.com/project-chip/matter.js/issues"
+    },
+    "homepage": "https://github.com/project-chip/matter.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/project-chip/matter.js.git"
+    },
+    "scripts": {
+        "clean": "matter-build clean",
+        "build": "matter-build",
+        "build-clean": "matter-build --clean",
+        "matter": "matter-run bin/matter.js"
+    },
+    "bin": {
+        "matter": "bin/matter.js"
+    },
+    "imports": {
+        "#tools": "@matter/tools",
+        "#general": "@matter/general",
+        "#model": "@matter/model",
+        "#types": "@matter/types",
+        "#protocol": "@matter/protocol",
+        "#node": "@matter/node",
+        "#*": "./src/*"
+    },
+    "dependencies": {
+        "@matter/general": "*",
+        "@matter/model": "*",
+        "@matter/node": "*",
+        "@matter/protocol": "*",
+        "@matter/tools": "*",
+        "@matter/types": "*",
+        "@types/escodegen": "^0.0.10",
+        "acorn": "^8.12.1",
+        "ansi-colors": "^4.1.3",
+        "escodegen": "^2.1.0",
+        "yargs": "^17.7.2"
+    },
+    "devDependencies": {
+        "@matter/tools": "*",
+        "@types/yargs": "^17.0.33"
+    },
+    "files": [
+        "dist/**/*",
+        "src/**/*",
+        "LICENSE",
+        "README.md"
+    ],
+    "type": "module",
+    "publishConfig": {
+        "access": "public"
+    }
+}

packages/cli-tool/src/cli.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { repl } from "#repl.js";
+import colors from "ansi-colors";
+import { stdout } from "process";
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+
+export async function main(argv: string[]) {
+    colors.enabled = stdout.isTTY;
+
+    await yargs(hideBin(argv)).usage("Interact with the local Matter environment.").strict().argv;
+
+    // TODO - REPL is enough for testing but need proper CLI
+
+    await repl();
+}

packages/cli-tool/src/commands/cat.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { bin } from "#globals.js";
+import { stdout } from "process";
+import { inspect } from "util";
+
+bin.cat = async function (...args: unknown[]) {
+    const locations = await Promise.all(args.map(arg => this.location.at(`${arg}`)));
+    for (const location of locations) {
+        stdout.write(inspect(location.definition, false, 1, stdout.isTTY));
+        stdout.write("\n");
+    }
+};
+
+bin.inspect = bin.cat;

packages/cli-tool/src/commands/cd.ts

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { NotADirectoryError, TooManyArgsError } from "#errors.js";
+import { bin } from "#globals.js";
+
+bin.cd = async function (path, ...extraArgs: unknown[]) {
+    if (extraArgs.length) {
+        throw new TooManyArgsError("cd");
+    }
+
+    if (path === undefined) {
+        path = "/";
+    } else {
+        path = `${path}`;
+    }
+
+    const location = await this.location.at(path as string);
+
+    if (location.kind !== "directory") {
+        throw new NotADirectoryError(path);
+    }
+
+    this.location = location;
+};

packages/cli-tool/src/commands/cwd.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { TooManyArgsError } from "#errors.js";
+import { bin } from "#globals.js";
+import { stdout } from "process";
+
+bin.cwd = function (...args: unknown[]) {
+    if (args.length) {
+        throw new TooManyArgsError("cwd");
+    }
+
+    stdout.write(this.location.path);
+    stdout.write("\n");
+};

packages/cli-tool/src/commands/help.ts

@@ -0,0 +1,14 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { bin } from "#globals.js";
+
+bin.help = function () {
+    // TODO - be helpful
+    process.stdout.write("Help is on the way!\n");
+};
+
+bin.man = bin.help;