@assemblyline/al-control 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-10-19
+
+First release as `@assemblyline/al-control`, forked from `fob-factory` 0.1.0 (FinOpsBricks).
+The history starts fresh here.
+
+### Changed
+- **BREAKING:** package `@assemblyline/al-control`, binary `al-control`.
+- **BREAKING:** config at `~/.assemblyline/al-control/config.yml` (override with
+  `AL_CONTROL_CONFIG_DIR`); each host lists `factories:`. SSH connection sockets live in the
+  same folder.
+- **BREAKING:** `-f/--factory` names the factory (was `-w/--worker`); `factories list` (was
+  `workers list`). Debug output with `AL_DEBUG=1`.
+- **BREAKING:** works on factory repos built on `@assemblyline/lib-factory`: process
+  detection, `procs start`, and the conveyor guard on `workpieces clear`
+  (`lib-factory:move_files`). The probe returns the factory's `.orchestrator/factory.json`.
+
+### Fixed
+- The conveyor guard on `workpieces clear` (and `lines show`) reads `move_files` steps that
+  use a `moves` array, not only a single `source_bin`; fob-factory missed those and would
+  offer their source bins for clearing.
+
+### Carried over from fob-factory
+- Hosts, local or over SSH with a piped probe (nothing installed on the host).
+- `lines`, `stations status`, `workpieces list/show/watch/count/errors/cat/open/clear`,
+  `procs list/start/stop/restart/logs/monit`, `config show`, `--json`, `--watch`.
+- Guarded `workpieces clear` of `done` and finished output only: dry run unless `--yes`,
+  `keep` bins, conveyor-fed bins skipped, and the probe re-checks every folder.
+- Probe queries `counts` and `requeue`.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Assembly Line
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,5 @@
+al-control
+Copyright 2026 Assembly Line
+
+This product includes software developed at Assembly Line, forked from fob-factory
+(Copyright 2026 FinOpsBricks, Apache-2.0).

package/README.md

@@ -1,3 +1,101 @@
-# Temporary Holding Version
+# al-control
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The control room CLI for [Assembly Line](https://assemblyline.sh): watch and operate factories on this machine or on machines you reach over SSH. See what's in every bin, why workpieces failed, and start or stop factory sessions.
+
+```bash
+al-control hosts use build-box
+al-control factories list
+al-control lines status -f factory-globex
+al-control workpieces watch inv-35 -f factory-globex
+al-control procs restart -f factory-globex
+al-control workpieces errors              # why things failed, on every factory
+```
+
+**Beta.** [Docs](https://assemblyline.sh/docs) · [About](https://assemblyline.sh) · [Changelog](CHANGELOG.md)
+
+## How it works
+
+```
+                    ~/.assemblyline/al-control/config.yml
+                    hosts → factories → paths
+                               │
+                    al-control (your machine)
+              resolve host + factory · logic · output
+                ┌──────────────┴──────────────┐
+          host: local                  host: <ssh alias>
+     probe in-process              ssh → node - (probe on stdin)
+     pm2 directly                  ssh → pm2
+                                   host needs node + pm2, nothing else
+```
+
+- **One config, one host at a time.** Like a kubectl context: `hosts use` picks the host, `--host` overrides it once.
+- **Factories are named, never inferred.** Per-factory commands take `-f <name>`; the current directory is ignored.
+- **Nothing installed on remote hosts.** A small read-only script is piped to the host's `node` over your own `ssh`, so `~/.ssh/config`, keys and Tailscale SSH all just work.
+
+## Install
+
+```bash
+npm install -g @assemblyline/al-control
+```
+
+Node.js 18+, macOS or Linux.
+
+## Config
+
+`~/.assemblyline/al-control/config.yml`:
+
+```yaml
+current_host: local
+hosts:
+  local:
+    factories:
+      factory-acme: ~/factories/factory-acme
+  build-box:
+    ssh: build-box            # alias from ~/.ssh/config
+    node: /home/me/.nvm/versions/node/v22.21.0/bin/node   # if node/pm2 come from nvm
+    factories:
+      factory-globex: ~/factories/factory-globex
+      factory-acme:                # long form: bins `workpieces clear` must never touch
+        path: ~/factories/factory-acme
+        keep: [VM5/output, VM5/done]
+```
+
+Factory paths are paths on that host. Remote hosts need key-based SSH (no password prompts). When to set `node:` — see [node and pm2 over non-interactive SSH](docs/architecture/node-and-pm2-over-non-interactive-ssh.md).
+
+## Commands
+
+| Command | Needs `-f` | What it does |
+| --- | --- | --- |
+| `hosts list` / `use <name>` / `current` | | Configured hosts; set the current one |
+| `factories list` | | Configured factories on the host, running or not, with CPU/RAM |
+| `lines list` / `show <line>` / `status [line]` | yes | Lines, their stations, live bin counts |
+| `stations status <code>` | yes | One station's bins and workpieces |
+| `workpieces list` / `show <id>` / `watch [id]` | yes | Where each workpiece is, its journey (and error, files), a live tail |
+| `workpieces count [failed\|done\|finished]` / `errors` | optional | Failed, done and finished counts; failures grouped by error. All factories unless `-f` |
+| `workpieces cat <id> <file>` / `open <id>` | yes | Read a file from a workpiece folder; open the folder (a shell in it, on a remote host) |
+| `workpieces clear --bin done\|finished` / `clear <id>` | yes | Delete done or finished workpieces, or one workpiece's copies; `--older-than <days>`. Dry run unless `--yes`; kept and conveyor-fed bins are skipped |
+| `procs list` | | Every factory process on the host |
+| `procs start` / `stop` / `restart` / `logs` | yes | pm2 control for one factory |
+| `procs monit` | | pm2's interactive monitor on the host |
+| `config show` | | Config path, hosts and factories |
+
+`--json` on list/show/status commands; `--watch` on `lines status` and `stations status`. `<command> --help` for every option.
+
+## al-control, al-orc and the `factory` command
+
+- **al-control** watches and operates the floor: bins, workpieces, failures and factory
+  sessions, wherever they run. No `steps run`; the only delete is the guarded
+  `workpieces clear`.
+- **[al-orc](https://github.com/assemblyline-sh/al-orc)** talks to the Orchestrator: line and
+  station definitions, runs, work records.
+- **`npx factory`** ships with [lib-factory](https://github.com/assemblyline-sh/lib-factory) in
+  every factory repo and runs one step locally while you build it.
+
+## Docs
+
+- [`docs/architecture/`](docs/architecture/) — how the pieces work and the constraints to keep (probe rules, SSH transport, pm2 matching).
+- [`docs/decisions/`](docs/decisions/) — why it's built this way, and what was rejected.
+
+## License
+
+Apache-2.0

package/bin/al-control.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+import { hideBin } from 'yargs/helpers';
+import { run } from '../src/cli/index.js';
+
+run(hideBin(process.argv));

package/package.json

@@ -1,6 +1,54 @@
 {
   "name": "@assemblyline/al-control",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "The control room CLI for Assembly Line: watch and operate factories across hosts, locally or over SSH",
+  "type": "module",
+  "bin": {
+    "al-control": "./bin/al-control.js"
+  },
+  "scripts": {
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/assemblyline-sh/al-control.git"
+  },
+  "keywords": [
+    "assembly-line",
+    "factory",
+    "control-room",
+    "cli",
+    "ssh",
+    "pm2",
+    "workflow-automation"
+  ],
+  "author": "Assembly Line",
+  "license": "Apache-2.0",
+  "files": [
+    "bin",
+    "src",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "js-yaml": "^4.1.0",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "jest": "^30.2.0",
+    "jest-junit": "^16.0.0"
+  },
+  "homepage": "https://assemblyline.sh",
+  "bugs": {
+    "url": "https://github.com/assemblyline-sh/al-control/issues"
+  }
+}

package/src/cli/_helpers.js

@@ -0,0 +1,14 @@
+/**
+ * Shared yargs helpers.
+ */
+
+/**
+ * Register a command's own "Options:" group so it renders *above* the inherited
+ * "Global Options:". yargs merges an instance's groups before the preserved
+ * global ones, and otherwise materialises the default "Options:" group last — so
+ * pre-creating it on the command instance is what fixes the order. Call at the
+ * start of a command's builder; ungrouped options then fall into this group.
+ */
+export function localOptions(yargs) {
+  return yargs.group([], 'Options:');
+}

package/src/cli/factories/list.js

@@ -0,0 +1,56 @@
+import path from 'node:path';
+
+import { probeProcesses } from '../../transport.js';
+import { formatTable } from '../../utils/format.js';
+
+/**
+ * `al-control factories list` — the current host's configured factories joined
+ * with what's running there.
+ * @param {{json?: boolean}} argv
+ * @param {import('../../config.js').HostContext} host
+ */
+export async function listFactoriesHandler(argv, host) {
+  if (Object.keys(host.factories).length === 0) {
+    if (argv.json) console.log(JSON.stringify([], null, 2));
+    else console.log(`No factories configured for host ${host.name}.`);
+    return;
+  }
+
+  const { factories, procs } = probeProcesses(host, { type: 'factories', paths: host.factories });
+  const rows = factories.map((w) => {
+    const pm2_name = path.posix.basename(w.root);
+    const proc = procs.find((r) => r.cwd === w.root || r.pm2 === pm2_name) ?? null;
+    let status;
+    if (!w.exists) status = 'missing';
+    else if (!w.main) status = 'not a factory';
+    else if (proc) status = `running (${proc.mode})`;
+    else status = 'stopped';
+    return {
+      name: w.name,
+      path: w.root,
+      status,
+      pid: proc?.pid ?? null,
+      cpu: proc?.cpu ?? null,
+      memory: proc?.memory ?? null,
+      uptime: proc?.uptime ?? null,
+    };
+  });
+
+  if (argv.json) {
+    console.log(JSON.stringify(rows, null, 2));
+    return;
+  }
+
+  console.log(formatTable(
+    ['FACTORY', 'STATUS', 'PID', 'CPU', 'MEM', 'UPTIME', 'PATH'],
+    rows.map((r) => [
+      r.name,
+      r.status,
+      r.pid ?? '—',
+      r.cpu === null ? '—' : `${r.cpu}%`,
+      r.memory === null ? '—' : `${Math.round(r.memory / 1024 / 1024)} MB`,
+      r.uptime ?? '—',
+      r.path,
+    ]),
+  ));
+}

package/src/cli/hosts.js

@@ -0,0 +1,59 @@
+import { loadConfig, useHost, configPath, factoryEntry, LOCAL_HOST } from '../config.js';
+import { formatTable } from '../utils/format.js';
+
+/**
+ * `al-control hosts list` — configured hosts; `*` marks the current one.
+ * Reads the config only; doesn't contact any host.
+ * @param {{json?: boolean}} argv
+ */
+export async function listHostsHandler(argv) {
+  const cfg = loadConfig();
+  const rows = Object.entries(cfg.hosts).map(([name, h]) => ({
+    name,
+    current: name === cfg.current_host,
+    ssh: name === LOCAL_HOST ? null : h.ssh,
+    factories: Object.keys(h.factories),
+  }));
+
+  if (argv.json) {
+    console.log(JSON.stringify(rows, null, 2));
+    return;
+  }
+
+  console.log(formatTable(
+    ['', 'HOST', 'SSH', 'FACTORYS'],
+    rows.map((r) => [r.current ? '*' : ' ', r.name, r.ssh ?? '(this machine)', r.factories.join(', ') || '—']),
+  ));
+  console.log('');
+  console.log(`Config: ${configPath()}`);
+}
+
+/**
+ * `al-control hosts use <name>`
+ * @param {{name: string}} argv
+ */
+export async function useHostHandler(argv) {
+  useHost(argv.name);
+  console.log(`Switched to host ${argv.name}.`);
+}
+
+/** `al-control hosts current` */
+export async function currentHostHandler() {
+  const { current_host } = loadConfig();
+  console.log(current_host ?? '(none — run `al-control hosts use <name>`)');
+}
+
+/** `al-control config show` — config path and contents as resolved. */
+export async function showConfigHandler() {
+  const cfg = loadConfig();
+  console.log(`Config:       ${configPath()}`);
+  console.log(`Current host: ${cfg.current_host ?? '(none)'}`);
+  for (const [name, h] of Object.entries(cfg.hosts)) {
+    console.log('');
+    console.log(`${name}${name === LOCAL_HOST ? ' (this machine)' : `  ssh: ${h.ssh}`}${h.node ? `  node: ${h.node}` : ''}`);
+    for (const [w, entry] of Object.entries(h.factories)) {
+      const { path, keep } = factoryEntry(entry);
+      console.log(`  ${w.padEnd(24)} ${path}${keep.length ? `  keep: ${keep.join(', ')}` : ''}`);
+    }
+  }
+}