xp-command 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Boris Diakur
+
+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,298 @@
+# 🛩 xp-command
+
+**Quick cockpit commands for X-Plane 12** - set your radios, altimeter, autopilot, and more from the terminal while flying.
+
+---
+
+## 🎯 What does this tool do?
+
+During instrument flight in X-Plane 12, constantly clicking tiny cockpit buttons to adjust altimeter, transponder, or radio frequencies can be tricky without the appropriate hardware. This tool lets you type quick commands like `q1013` or `x7000` to instantly set instruments without touching the mouse.
+
+**Example commands:**
+- `q1013` → Set altimeter to 1013 hPa
+- `x7000` → Set transponder to 7000
+- `a250` → Set autopilot altitude to FL250
+- `c1118900` → Set COM1 to 118.900 MHz
+
+The tool remembers your command history and automatically creates aircraft-specific profiles which can then be adjusted to your specific needs.
+
+---
+
+## 🚀 Installation
+
+### Step 1: Install Node.js
+
+You need Node.js version 22 or higher installed on your system:
+
+1. **Download Node.js**: Go to https://nodejs.org/en/download/ and download the **LTS version** (Long Term Support)
+2. **Install**: Run the downloaded installer
+3. **Verify**: Open Terminal and type:
+   ```bash
+   node --version
+   ```
+   You should see something like `v22.x.x`
+
+### Step 2: Install xp-command globally
+
+Open Terminal and run:
+
+```bash
+npm install -g xp-command
+```
+
+This installs xp-command globally so you can run it from anywhere.
+
+---
+
+## 🛠 X-Plane setup
+
+You shouldn't need to perform any extra setup steps in X-Plane. There is no plugin that needs to be installed. If you still want to check if the Web API (which allows xp-command to communicate with X-Plane) is configured correctly, here is how you can do it:
+
+1. In X-Plane 12, go to **Settings → Data Output**
+2. Find **"Enable Web Server API"** and make sure it's enabled
+3. Note the **port number** (default is `8086`)
+
+---
+
+## 🎮 Usage
+
+### Starting the tool
+
+1. **Load into an aircraft** in X-Plane 12
+2. **Open Terminal** on your machine
+3. **Run**:
+   ```bash
+   xp-command
+   ```
+
+You'll see a prompt:
+```
+🛩 █
+```
+
+Now you can enter commands!
+
+### Using a custom port
+
+If you changed the Web API port from 8086 to another port, you'll need to start xp-command accordingly:
+
+```bash
+xp-command --port 8090
+```
+
+### Exiting
+
+Type `exit` or press `Ctrl+C`
+
+---
+
+## 📋 Pre-configured commands
+
+All pre-configured commands work well with most aircraft I currently fly, but you may want to adjust them for **your** aircraft (see _Aircraft-specific profiles_ section below).
+
+### Barometric Pressure
+
+| Command | Action                                  | Example      |
+|---------|-----------------------------------------|--------------|
+| `q`     | Get QNH in hPa/mb (copied to clipboard) | `q` → `1013` |
+| `l`     | Get QNH in inHg (copied to clipboard)   | `l` → `2992` |
+| `q####` | Set QNH in hPa/mb                       | `q1013`      |
+| `l####` | Set QNH in inHg                         | `l2992`      |
+
+### Autopilot
+
+| Command  | Action                      | Example                   |
+|----------|-----------------------------|---------------------------|
+| `h###`   | Set heading                 | `h090` → 090°             |
+| `a###`   | Set altitude (flight level) | `a250` → FL250 (25000 ft) |
+| `a#####` | Set altitude (exact feet)   | `a03500` → 3500 ft        |
+| `s###`   | Set speed in KIAS           | `s180` → 180 knots        |
+| `s##`    | Set speed in Mach           | `s78` → Mach 0.78         |
+| `v####`  | Set vertical speed          | `v1500` → 1500 ft/min     |
+
+### Radios
+
+| Command    | Action           | Format     | Example               |
+|------------|------------------|------------|-----------------------|
+| `c1#####`  | Set COM1 active  | No decimal | `c1118900` → 118.900  |
+| `cs1#####` | Set COM1 standby | No decimal | `cs1121750` → 121.750 |
+| `c2#####`  | Set COM2 active  | No decimal | `c2119200` → 119.200  |
+| `cs2#####` | Set COM2 standby | No decimal | `cs2122800` → 122.800 |
+| `n1#####`  | Set NAV1 active  | No decimal | `n1110500` → 110.500  |
+| `ns1#####` | Set NAV1 standby | No decimal | `ns1116600` → 116.600 |
+| `n2#####`  | Set NAV2 active  | No decimal | `n2113900` → 113.900  |
+| `ns2#####` | Set NAV2 standby | No decimal | `ns2115700` → 115.700 |
+
+**Radio frequency format:** Remove the decimal point. For `118.900`, type `118900`. For COM1 and COM2 you can omit the last digit – the value will be padded with 0.
+
+### Transponder
+
+| Command | Action          | Example |
+|---------|-----------------|---------|
+| `x####` | Set squawk code | `x7000` |
+
+---
+
+## ⚙️ Aircraft-specific profiles
+
+The first time you run xp-command in a new aircraft, it automatically creates a configuration file at:
+
+```
+~/.xp-command/<Aircraft Name>.yml
+```
+
+### Customizing commands
+
+You can edit these YAML files to add aircraft-specific commands or modify existing ones. Note that for changes to take effect you'll need to restart xp-command.
+
+**Example**: Add a command to set heading with 10-degree increments:
+
+```yaml
+  - pattern: "^hdg(\\d{2})$"  
+    type: set
+    dataref: sim/cockpit/autopilot/heading_mag
+    transform:
+      - mult10
+```
+
+**Key components:**
+- `pattern`: Regular expression matching your command (`hdg18`)
+- `type`: Either `get` (read value) or `set` (write value)
+- `dataref`: X-Plane dataref path (find these in X-Plane's DataRef Editor)
+- `transform`: Optional value conversions (multiply, divide, round, etc.)
+
+**Finding datarefs**: Use X-Plane's built-in **DataRef Editor** plugin or check [X-Plane datarefs documentation](https://developer.x-plane.com/datarefs/).
+
+#### Array Datarefs
+
+Many X-Plane datarefs are arrays (e.g., for multiple engines, generators, radios). You can access specific array elements using `[index]` notation:
+
+```yaml
+# Check if right generator is on (index 1 = right, 0 = left)
+- pattern: "^gr$"
+  type: get
+  dataref: sim/cockpit/electrical/generator_on[1]
+```
+
+## 🔄 Resetting Aircraft Profiles
+
+If you've edited an aircraft configuration and xp-command crashes or stops working, you can reset to default settings by deleting the config files.
+
+### Profile Location
+
+Aircraft profiles are stored in:
+
+**macOS/Linux:** `~/.xp-command/`  
+**Windows:** `%USERPROFILE%\.xp-command\`
+
+Each aircraft has its own `.yml` file named after the aircraft (e.g., `Cessna 172SP.yml`).
+
+### Reset Single Aircraft
+
+To reset one specific aircraft, delete its `.yml` file. Next time you load that aircraft and run a command, xp-command will create a fresh default configuration.
+
+### Reset All Aircraft  
+
+To start completely fresh, delete the entire `.xp-command` folder. This removes all custom aircraft configurations.
+The tool will automatically recreate default configurations when you next fly each aircraft and run a command.
+
+---
+
+## 🔧 Troubleshooting
+
+### "No connection - in aircraft?"
+
+**Causes:**
+- You're in the X-Plane menu (not loaded into cockpit)
+- Web API is disabled in X-Plane settings
+- X-Plane is not running
+- Wrong port number
+
+**Fix:**
+1. Load into aircraft cockpit
+2. Check **Settings → Data Output → Enable Web Server API** is checked
+3. Verify port matches (default 8086)
+
+### Command not recognized (red text)
+
+**Causes:**
+- Typo in command
+- Command not defined for this aircraft
+- Wrong number of digits
+
+**Fix:**
+- Check command format in this README
+- Edit `~/.xp-command/<Aircraft>.yml` to add custom commands
+
+### Values not changing in cockpit
+
+**Causes:**
+- Wrong dataref for your specific aircraft
+- Aircraft systems override (e.g., autopilot off)
+
+**Fix:**
+- Check DataRef Editor to verify correct dataref path
+- Ensure aircraft systems are in correct mode (e.g., autopilot engaged)
+
+### xp-command crashes after parsing errors
+  
+**Cause:** Invalid YAML syntax when editing config files  
+**Fix:** Create backups of problematic aircraft's `.yml` files and delete them or the entire profiles folder
+
+---
+
+## 🗑️ Uninstalling
+
+### Uninstall npm package
+
+Open Terminal and run:
+
+```bash
+npm uninstall -g xp-command
+```
+
+### Clean Up Data Files
+
+**Aircraft profiles:**
+- macOS/Linux: Delete `~/.xp-command/` folder
+- Windows: Delete `%USERPROFILE%\.xp-command\` folder
+
+**Command history:**
+- macOS: Delete `~/Library/Preferences/xp-command-nodejs/` folder
+- Linux: Delete `~/.config/xp-command-nodejs/` folder  
+- Windows: Delete `%APPDATA%\xp-command-nodejs\` folder
+
+**Complete removal:** Delete both the tool and all data files to fully uninstall xp-command from your system.
+
+---
+
+## 🛣 How it works (technical overview)
+
+1. **Web API connection**: Uses [X-Plane local REST Web API](https://developer.x-plane.com/article/x-plane-web-api/) 
+2. **Dataref system**: Reads/writes X-Plane datarefs (internal simulator variables)
+3. **Pattern matching**: Regular expressions match your commands to datarefs
+4. **Transform pipeline**: Converts your input format to X-Plane's expected values
+5. **Aircraft profiles**: YAML configs loaded based on current aircraft name
+6. **Persistent history**: Stored using the [`conf`](https://github.com/sindresorhus/conf) package
+
+---
+
+## 📝 License
+
+MIT License - See repository for details
+
+---
+
+## 🙏 Credits
+
+This project was inspired by http://www.xpluginsdk.org/command_line.htm which unfortunately stopped working for me after upgrading to X-Plane 12.
+
+---
+
+## 🐛 Issues and contributions
+
+Found a bug or want to add features? Submit issues or pull requests on the [GitHub repository](https://github.com/borisdiakur/xp-command).
+
+---
+
+**👋🏻 Happy flying!**

package/bin/index.js

@@ -0,0 +1,240 @@
+#!/usr/bin/env node
+
+import {
+  createPrompt,
+  isDownKey,
+  isEnterKey,
+  isUpKey,
+  useKeypress,
+  useState,
+} from "@inquirer/core";
+import chalk from "chalk";
+import { program } from "commander";
+import ora from "ora";
+
+import { getDatarefValue, initAPI, setDatarefValue } from "../src/api.js";
+import { copyToClipboard } from "../src/clipboard.js";
+import { getConfig } from "../src/config.js";
+import { clearLine, hideCursor, showCursor } from "../src/console.js";
+import { isEconnRefused } from "../src/error.js";
+import history from "../src/history.js";
+import { sleep } from "../src/sleep.js";
+
+const PREFIX = "🛩 ";
+
+program
+  .version("1.0.0")
+  .description("xp-command")
+  .option("-p, --port <number>", "server port number");
+
+/**
+ * @param {string} command
+ */
+const processCommand = async (command) => {
+  const spinner = ora(`${PREFIX} ${chalk.cyan(command)}`).start();
+  hideCursor();
+
+  /** @type {import('../src/config.js').CommandConfig} */
+  let config;
+  try {
+    config = await getConfig();
+  } catch (error) {
+    if (isEconnRefused(error)) {
+      spinner.fail(chalk.red(`${PREFIX} No connection - in aircraft?`));
+      hideCursor();
+      await sleep(1500);
+      showCursor();
+      return;
+    }
+  }
+
+  /**
+   * @param {number|Array<number>|string} value
+   * @param {import('../src/config.js').Transform} transform
+   */
+  const getTransformedValue = (value, transform) => {
+    if (Array.isArray(value)) return value.slice();
+
+    if (transform.startsWith("mult")) {
+      const factor = parseFloat(transform.slice(4));
+      if (isNaN(factor)) return value;
+      return Number(value) * factor;
+    }
+
+    if (transform.toLowerCase().startsWith("tofixed")) {
+      const digits = parseInt(transform.slice(7));
+      if (isNaN(digits)) return value;
+      return Number(Number(value).toFixed(digits));
+    }
+
+    if (transform === "round") {
+      return Math.round(Number(value));
+    }
+
+    return value;
+  };
+
+  /** @type {Array<[RegExp, (regExpResult: Array<string> | null) => Promise<void>]>} */
+  const matches = config.commands.map((c) => {
+    switch (c.type) {
+      case "get":
+        return [
+          new RegExp(c.pattern),
+          async () => {
+            let value = await getDatarefValue(c.dataref);
+            c.transform?.forEach((t) => {
+              value = getTransformedValue(value, t);
+            });
+            await copyToClipboard(JSON.stringify(value));
+            spinner.succeed(chalk.green(`${PREFIX} ${value}`));
+            hideCursor();
+            await sleep(1500);
+            clearLine();
+          },
+        ];
+      case "set":
+        return [
+          new RegExp(c.pattern),
+          async (regExpResult) => {
+            let value = regExpResult[1];
+            c.transform?.forEach((t) => {
+              value = String(getTransformedValue(value, t));
+            });
+
+            await setDatarefValue(c.dataref, Number(value));
+            spinner.succeed(chalk.green(`${PREFIX} ${command}`));
+            hideCursor();
+            await sleep(1500);
+            clearLine();
+          },
+        ];
+    }
+  });
+
+  for (const [regexp, cb] of matches) {
+    const regexpResult = regexp.exec(command);
+    if (regexpResult !== null) {
+      try {
+        await cb(regexpResult);
+
+        spinner.succeed();
+        hideCursor();
+
+        showCursor();
+      } catch (error) {
+        spinner.fail();
+        hideCursor();
+
+        if (error instanceof Error) {
+          if (isEconnRefused(error)) {
+            clearLine();
+            spinner.fail(chalk.red(`${PREFIX} No connection - in aircraft?`));
+            await sleep(1500);
+          } else if (error.name === "APIError") {
+            clearLine();
+            spinner.fail(chalk.red(`${PREFIX} ${error.message}`));
+            await sleep(1500);
+          } else {
+            throw error;
+          }
+        } else {
+          throw error;
+        }
+
+        await sleep(500);
+        showCursor();
+      }
+      return;
+    }
+  }
+
+  spinner.fail(chalk.red(`${PREFIX} ${command}`));
+  hideCursor();
+
+  await sleep(1500);
+  showCursor();
+};
+
+const sayHello = () => {
+  console.log(chalk.magenta("  👋 Hello!"));
+};
+const sayBye = () => {
+  console.log(chalk.magenta("  👋 Bye!"));
+};
+
+const askForCommand = async () => {
+  clearLine();
+
+  const prompt = createPrompt((config, done) => {
+    const [value, setValue] = useState();
+    const [, setStatus] = useState("idle");
+
+    useKeypress((key, readline) => {
+      if (isEnterKey(key)) {
+        setStatus("done");
+        history.addCommand(value);
+        done(value);
+      } else if (isUpKey(key)) {
+        const v = history.up();
+        setValue(v);
+        readline.line = v;
+      } else if (isDownKey(key)) {
+        const v = history.down();
+        setValue(v);
+        readline.line = v;
+      } else {
+        setValue(readline.line);
+      }
+    });
+
+    return `${config[0].theme.prefix} ${config[0].message ?? ""} ${value ?? ""}`;
+  });
+
+  const command = await prompt(
+    [
+      {
+        type: "input",
+        name: "command",
+        message: "",
+        theme: {
+          prefix: "  🛩",
+        },
+      },
+    ],
+    { clearPromptOnDone: true },
+  );
+
+  if (command.toLowerCase() === "exit") {
+    sayBye();
+    return;
+  }
+
+  await processCommand(command);
+
+  await askForCommand();
+};
+
+program.action(async (/** @type {{ port: number | undefined }} */ options) => {
+  initAPI({ port: options.port ?? 8086 });
+
+  hideCursor();
+  clearLine();
+  sayHello();
+  await sleep(1000);
+  showCursor();
+
+  await askForCommand();
+});
+
+program.parse(process.argv);
+
+process.on("uncaughtException", (error) => {
+  if (error instanceof Error) {
+    if (error.name === "ExitPromptError") {
+      clearLine();
+      sayBye();
+      return;
+    }
+  }
+  throw error;
+});

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "xp-command",
+  "version": "1.0.0",
+  "description": "Quick cockpit commands for X-Plane 12 - set your radios, altimeter, autopilot, and more from the terminal while flying.",
+  "type": "module",
+  "bin": {
+    "xp-command": "./bin/index.js"
+  },
+  "scripts": {
+    "start": "node bin/index.js",
+    "start:clean": "npm run clean && npm start",
+    "clean": "rm -rf ~/.xp-command/"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^24.9.2",
+    "eslint": "^9.39.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "globals": "^16.5.0",
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.46.2"
+  },
+  "keywords": [
+    "X-Plane"
+  ],
+  "author": "Boris Diakur (https://borisdiakur.de)",
+  "repository": "borisdiakur/xp-command",
+  "license": "MIT",
+  "dependencies": {
+    "@inquirer/core": "^10.3.0",
+    "chalk": "^5.6.2",
+    "commander": "^14.0.2",
+    "conf": "^15.0.2",
+    "inquirer": "^12.10.0",
+    "js-yaml": "^4.1.0",
+    "ora": "^9.0.0"
+  },
+  "engines": {
+    "node": ">=22"
+  }
+}

package/src/api.js

@@ -0,0 +1,138 @@
+/** @type {number} */
+let port;
+
+/**
+ * @typedef {{
+ *   error_code: string
+ *   error_message: string
+ * }} APIError
+ */
+
+/**
+ * @typedef {{
+ *   port: number
+ * }} APIOptions
+ */
+
+class CustomError extends Error {
+  constructor(/** @type {string} */ message) {
+    super(message);
+    this.name = "APIError";
+  }
+}
+
+/**
+ * @param {string} datarefString
+ * @return {[string, number|null]}
+ */
+const parseDataref = (datarefString) => {
+  // Regex pattern: captures base name and optional array index
+  const pattern = /^(.+?)(?:\[(\d+)\])?$/;
+  const match = datarefString.match(pattern);
+
+  if (!match) {
+    throw new CustomError("invalid_dataref");
+  }
+
+  return [match[1], match[2] ? parseInt(match[2]) : null];
+};
+
+/**
+ * @param {string} datarefName
+ * @return { Promise<number | null> }
+ */
+const getDatarefId = async (datarefName) => {
+  const url = new URL(`http://localhost:${port}/api/v2/datarefs`);
+  url.searchParams.set("filter[name]", datarefName);
+  url.searchParams.set("fields", "id");
+
+  const response = await fetch(url);
+  const json = /** @type { {data:[{id: number }]} | APIError } */ (
+    await response.json()
+  );
+
+  if ("error_code" in json) {
+    throw new CustomError(json.error_code);
+  }
+
+  return json.data[0]?.id ?? null;
+};
+
+/**
+ * @param {APIOptions} options
+ */
+export const initAPI = (options) => {
+  port = options.port;
+};
+
+/**
+ * @param {string} datarefNameWithOptionalIndex
+ * @return {Promise<number|Array<number>|string>}
+ */
+export const getDatarefValue = async (datarefNameWithOptionalIndex) => {
+  const [datarefName, index] = parseDataref(datarefNameWithOptionalIndex);
+
+  const datarefId = await getDatarefId(datarefName);
+
+  const url = new URL(
+    `http://localhost:${port}/api/v2/datarefs/${datarefId}/value`,
+  );
+  if (typeof index === "number") {
+    url.searchParams.set("index", String(index));
+  }
+
+  const response = await fetch(url);
+  const json =
+    /** @type { {data: number|Array<number>|string } | APIError } */ (
+      await response.json()
+    );
+
+  if ("error_code" in json) {
+    throw new CustomError(json.error_code);
+  }
+
+  if (typeof json.data === "string") {
+    const decoded = Buffer.from(json.data, "base64")
+      .toString("utf-8")
+      .replaceAll("\x00", "")
+      .trim();
+    return decoded;
+  }
+
+  if (Array.isArray(json.data) && json.data.length === 1) {
+    return JSON.stringify(json.data[0]);
+  }
+
+  return JSON.stringify(json.data);
+};
+
+/**
+ * @param {string} datarefNameWithOptionalIndex
+ * @param {number|Array<number>} [value]
+ */
+export const setDatarefValue = async (datarefNameWithOptionalIndex, value) => {
+  const [datarefName, index] = parseDataref(datarefNameWithOptionalIndex);
+
+  const datarefId = await getDatarefId(datarefName);
+
+  const url = new URL(
+    `http://localhost:${port}/api/v2/datarefs/${datarefId}/value`,
+  );
+  if (typeof index === "number") {
+    url.searchParams.set("index", String(index));
+  }
+
+  const response = await fetch(url, {
+    method: "PATCH",
+    body: JSON.stringify({ data: value }),
+  });
+  const json = /** @type { {data: number|Array<number> } | APIError } */ (
+    await response.json()
+  );
+
+  if (json && "error_code" in json) {
+    throw new CustomError(json.error_code);
+  }
+
+  return json;
+};

package/src/clipboard.js

@@ -0,0 +1,19 @@
+import { exec } from "child_process";
+
+/**
+ * @param {string|number} text
+ */
+export const copyToClipboard = async (text) => {
+  const command =
+    process.platform === "win32"
+      ? `echo ${text} | clip`
+      : process.platform === "darwin"
+        ? `echo "${text}" | pbcopy`
+        : `echo "${text}" | xclip -selection clipboard`;
+
+  await new Promise((resolve) => {
+    exec(command, () => {
+      resolve();
+    });
+  });
+};

package/src/config.js

@@ -0,0 +1,69 @@
+import { copyFile, mkdir, readFile } from "node:fs/promises";
+
+import yaml from "js-yaml";
+import { homedir } from "os";
+import { dirname } from "path";
+import { join } from "path";
+import { fileURLToPath } from "url";
+
+import { getDatarefValue } from "./api.js";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+/**
+ * @typedef {Object} CommandConfig
+ * @property {Command[]} commands - Array of command definitions
+ */
+
+/**
+ * @typedef {Object} Command
+ * @property {RegExp} pattern - Regular expression pattern to match commands
+ * @property {'get' | 'set'} type - Operation type
+ * @property {string} dataref - X-Plane dataref path
+ * @property {Transform[]} transform - Array of transformation operations to apply
+ */
+
+/**
+ * @typedef {'mult100' | 'round' | 'div100' | 'toFixed2'} Transform
+ * Transform operations:
+ * - mult100: Multiply by 100
+ * - round: Round to nearest integer
+ * - div100: Divide by 100
+ * - toFixed2: Format to 2 decimal places
+ */
+
+const osHomedir = homedir();
+
+/**
+ * @return {Promise<CommandConfig>}
+ */
+export const getConfig = async () => {
+  await mkdir(join(osHomedir, ".xp-command"), {
+    recursive: true,
+  });
+
+  /** @type {string} */
+  let aircraft;
+  aircraft = /** @type {string} */ (
+    await getDatarefValue("sim/aircraft/view/acf_ui_name")
+  );
+  const aircraftConfigPath = join(osHomedir, ".xp-command", `${aircraft}.yml`);
+
+  let config;
+  try {
+    const file = await readFile(aircraftConfigPath, "utf8");
+    config = yaml.load(file);
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      await copyFile(join(__dirname, "config.yml"), aircraftConfigPath);
+    } else {
+      throw error;
+    }
+
+    const file = await readFile(aircraftConfigPath, "utf8");
+    config = yaml.load(file);
+  }
+
+  return /** @type {CommandConfig} */ (config);
+};

package/src/config.yml

@@ -0,0 +1,137 @@
+commands:
+  # get barometric pressure at sealevel in inHg (dddd format)
+  - pattern: "^l$"
+    type: get
+    dataref: sim/weather/barometer_sealevel_inhg
+    transform:
+      - mult100
+      - round
+
+  # get barometric pressure at sealevel in hPa/mb (dddd format)
+  - pattern: "^q$"
+    type: get
+    dataref: sim/weather/barometer_sealevel_inhg
+    transform:
+      - mult33.8637526
+      - round
+
+  # set barometric pressure at sealevel in inHg (dddd format)
+  - pattern: "^l(\\d{4})$"
+    type: set
+    dataref: sim/cockpit/misc/barometer_setting
+    transform:
+      - mult0.01
+      - toFixed2
+
+  # set barometric pressure at sealevel in hPa/mb (dddd format)
+  - pattern: "^q(\\d{4})$"
+    type: set
+    dataref: sim/cockpit/misc/barometer_setting
+    transform:
+      - mult0.02953009998
+      - toFixed2
+
+  # set heading
+  - pattern: "^h(\\d{3})$"
+    type: set
+    dataref: sim/cockpit/autopilot/heading_mag
+
+  # set transponder code
+  - pattern: "^x(\\d{4})$"
+    type: set
+    dataref: sim/cockpit/radios/transponder_code
+
+  # set autopilot airspeed in KIAS
+  - pattern: "^s(\\d{3})$"
+    type: set
+    dataref: sim/cockpit/autopilot/airspeed
+
+  # set autopilot airspeed in MACH
+  - pattern: "^s(\\d{2})$"
+    type: set
+    dataref: sim/cockpit/autopilot/airspeed
+    transform:
+      - mult0.01
+      - toFixed2
+
+  # set autopilot vertical speed
+  - pattern: "^v(\\d\\d?\\d?\\d?)$"
+    type: set
+    dataref: sim/cockpit/autopilot/vertical_velocity
+
+  # set autopilot target altitude
+  - pattern: "^a((0|\\d\\d\\d\\d\\d?))$"
+    type: set
+    dataref: sim/cockpit/autopilot/altitude
+
+  # set autopilot target flight level
+  - pattern: "^a(\\d\\d\\d?)$"
+    type: set
+    dataref: sim/cockpit/autopilot/altitude
+    transform:
+      - mult10
+      - round
+
+  # set com1 frequency
+  - pattern: "^c1(\\d{6})$"
+    type: set
+    dataref: sim/cockpit2/radios/actuators/com1_frequency_hz_833
+  - pattern: "^c1(\\d{5})$"
+    type: set
+    dataref: sim/cockpit2/radios/actuators/com1_frequency_hz_833
+    transform:
+      - mult10
+      - round
+
+  # set com1 standby frequency
+  - pattern: "^cs1(\\d{6})$"
+    type: set
+    dataref: sim/cockpit2/radios/actuators/com1_standby_frequency_hz_833
+  - pattern: "^cs1(\\d{5})$"
+    type: set
+    dataref: sim/cockpit2/radios/actuators/com1_standby_frequency_hz_833
+    transform:
+      - mult10
+      - round
+
+  # set com2 frequency
+  - pattern: "^c2(\\d{6})$"
+    type: set
+    dataref: sim/cockpit2/radios/actuators/com2_frequency_hz_833
+  - pattern: "^c2(\\d{5})$"
+    type: set
+    dataref: sim/cockpit2/radios/actuators/com2_frequency_hz_833
+    transform:
+      - mult10
+      - round
+
+  # set com2 standby frequency
+  - pattern: "^cs2(\\d{6})$"
+    type: set
+    dataref: sim/cockpit2/radios/actuators/com2_standby_frequency_hz_833
+  - pattern: "^cs2(\\d{5})$"
+    type: set
+    dataref: sim/cockpit2/radios/actuators/com2_standby_frequency_hz_833
+    transform:
+      - mult10
+      - round
+
+  # set nav1 frequency
+  - pattern: "^n1(\\d{5})$"
+    type: set
+    dataref: sim/cockpit/radios/nav1_freq_hz
+
+  # set nav1 standby frequency
+  - pattern: "^ns1(\\d{5})$"
+    type: set
+    dataref: sim/cockpit/radios/nav1_stdby_freq_hz
+
+  # set nav2 frequency
+  - pattern: "^n2(\\d{5})$"
+    type: set
+    dataref: sim/cockpit/radios/nav2_freq_hz
+
+  # set nav2 standby frequency
+  - pattern: "^ns2(\\d{5})$"
+    type: set
+    dataref: sim/cockpit/radios/nav2_stdby_freq_hz

package/src/console.js

@@ -0,0 +1,12 @@
+export const clearLine = (dy = -1) => {
+  process.stdout.moveCursor(0, dy);
+  process.stdout.clearLine(0);
+  process.stdout.cursorTo(0);
+};
+
+export const hideCursor = () => {
+  process.stdout.write("\x1B[?25l");
+};
+export const showCursor = () => {
+  process.stdout.write("\x1B[?25h");
+};

package/src/error.js

@@ -0,0 +1,12 @@
+/**
+ * @param {unknown} error
+ */
+export const isEconnRefused = (error) => {
+  return Boolean(
+    error instanceof Error &&
+      error.cause &&
+      typeof error.cause === "object" &&
+      "code" in error.cause &&
+      error.cause.code === "ECONNREFUSED",
+  );
+};

package/src/history.js

@@ -0,0 +1,53 @@
+import Conf from "conf";
+
+class CliHistory {
+  /** @type {Conf} */
+  config;
+
+  /** @type {number} */
+  index;
+
+  constructor() {
+    this.config = new Conf({
+      projectName: "xp-command",
+    });
+
+    this.index = this.getHistory().length - 1;
+  }
+
+  /**
+   * @param {string} command
+   * @returns {void}
+   */
+  addCommand(command) {
+    const history = this.getHistory();
+
+    const filtered = history.filter((cmd) => cmd !== command);
+    filtered.push(command);
+    const trimmed = filtered.slice(-100);
+
+    this.config.set("history", trimmed);
+    this.index = trimmed.length - 1;
+  }
+
+  getHistory() {
+    return /** @type {Array<string>} */ (this.config.get("history") ?? []);
+  }
+
+  clear() {
+    this.config.set("history", []);
+    this.index = 0;
+  }
+
+  up() {
+    this.index = Math.max(0, this.index - 1);
+    return this.getHistory()[this.index + 1] ?? "";
+  }
+
+  down() {
+    this.index = Math.min(this.getHistory().length - 1, this.index + 1);
+    return this.getHistory()[this.index + 1] ?? "";
+  }
+}
+
+export default new CliHistory();

package/src/sleep.js

@@ -0,0 +1,6 @@
+/**
+ * @param {number} ms
+ */
+export const sleep = async (ms) => {
+  await new Promise((resolve) => setTimeout(resolve, ms));
+};