alexandr 0.0.1 → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+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 {yyyy} {name of copyright owner}
+
+   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/README.md

@@ -1,13 +1,112 @@
 # alexandr
 
-The self-hosted AI workspace runtime — CLI.
+Deploy and operate an **alexandr** workspace runtime with one command. A thin,
+zero-dependency front door over Docker — it pulls and boots the published kernel
+image; it does not bundle a runtime.
 
-> **This is a placeholder** reserving the `alexandr` name on npm. The real CLI is on
-> the way: a thin, developer-friendly front door that pulls and boots the alexandr
-> runtime locally via Docker.
+> This is the tooling the alexandr team uses to stand up **on-premise / Enterprise**
+> deployments, and that developers use to run a **local runtime**. DIY self-hosting is
+> not a general-availability offering — on-premise deployments are delivered by the
+> alexandr team ([talk to us](https://alexandr.so/enterprise)).
 
 ```sh
-npx alexandr up      # pull + boot the runtime locally (coming soon)
+npx alexandr@latest up      # first run asks its few questions, then: sign in, pull + boot
+# or
+npm install -g alexandr
+alexandr up
 ```
 
-Track progress → https://github.com/alexandrco/alexandr
+On a fresh machine `up` is interactive — it asks how the runtime should be
+reachable (just this machine, or a public domain with automatic HTTPS), the
+port or domain, and the workspace name. Flags (`--domain`, `--port`, `--name`),
+`--yes`, or a non-TTY skip the questions and keep `up` fully scriptable; re-runs
+never prompt (`up` stays an idempotent restart).
+
+On a fresh **Linux** server `up` also handles its own dependencies: when Docker
+or Compose v2 is missing it offers to install them right there (Docker's
+official `get.docker.com` script + a systemd start; root or sudo, always asked
+first). macOS/Windows get instructions instead — Docker Desktop can't be
+installed silently.
+
+Sign-in comes next: every runtime is linked to an alexandr account before it
+serves anyone — `up` opens the browser once, then boots the box already linked.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `alexandr up` | Sign in (first run), pull + boot the runtime; print the URL |
+| `alexandr down` | Stop it (data preserved) |
+| `alexandr status` | State, version, URL, data size (`--json` for machines) |
+| `alexandr ls` | List all instances |
+| `alexandr logs -f` | Tail kernel logs |
+| `alexandr connect` | Print the `alexandr://connect` link / paste-string |
+| `alexandr link` | Re-link this runtime to your account (`--force` re-registers) |
+| `alexandr update` | Update the runtime image (`--to <tag>`, `--rollback`); auto-snapshots `/data` first (`--no-backup` to skip) |
+| `alexandr backup` / `restore <f>` | Archive / restore the data volume |
+| `alexandr config set <k> <v>` | Edit config (`ai.url`, `model`, `port`, `domain`, …) |
+| `alexandr init` | Write a committable `./alexandr` config folder |
+| `alexandr destroy [--volumes] [--unlink]` | Remove containers (and optionally `/data` / the account record) |
+| `alexandr completion <bash\|zsh\|fish>` | Print a shell completion script |
+| `alexandr doctor` | Check Docker, ports, config |
+
+Common flags: `--port`, `--domain`, `--name`, `--dir`, `--open`, `--offline`, `--yes`.
+
+## Updates are reversible
+
+`alexandr update` snapshots the data volume into `<instance>/backups/` *before* it
+pulls the new image, so a bad release (e.g. a forward-only migration) can be undone
+with `alexandr restore`. Pass `--no-backup` to skip the snapshot (e.g. a large volume
+in CI). `--rollback` re-pins the previous image; the data snapshot covers the rest.
+
+## Shell completion
+
+```sh
+source <(alexandr completion bash)                        # bash (add to ~/.bashrc)
+alexandr completion zsh  > ~/.zsh/completions/_alexandr   # zsh (a dir on your $fpath)
+alexandr completion fish > ~/.config/fish/completions/alexandr.fish
+```
+
+## Exit codes
+
+Every failure class has a distinct, stable exit code, so scripts can branch on *why*
+a command failed:
+
+| Code | Meaning |
+|---|---|
+| `0` | success |
+| `1` | general / unexpected error |
+| `2` | usage error (unknown command/subcommand, missing or bad argument) |
+| `3` | Docker not installed / not on `PATH` |
+| `4` | Docker daemon not running |
+| `5` | Docker Compose v2 plugin missing |
+| `6` | requested port already in use |
+| `7` | no instance where one is required |
+| `8` | a destructive command needs `--yes` |
+| `9` | a Docker/Compose operation failed at runtime |
+
+## How it works
+
+- **Docker only.** Requires Docker + Compose v2. `alexandr doctor` checks this.
+- **State.** The global instance lives at `~/.alexandr/workspace/` (named instances via
+  `--name <n>` → `~/.alexandr/<n>/`); `alexandr init` creates a committable project
+  instance under `./alexandr/` (its `.env` is gitignored). The instance folder holds
+  only config (compose file, Caddyfile, `.env`, backups) — workspace data lives in a
+  Docker named volume, and commands find the instance from any directory.
+- **Auth.** Identity is owned by the control plane; the runtime is a pure verifier that
+  owns no login. Every runtime must be **linked to an alexandr account before it serves
+  anyone** — `alexandr up` signs you in as step one and writes the credentials into the
+  instance `.env`; an unlinked boot shows only a static "isn't linked" page. Access is
+  your account sign-in — there are no static access tokens. Self-hosted workspaces open
+  in the **Alexandr desktop app**: a browser at the box (exposed `--domain` or loopback)
+  gets an "open in the Alexandr app" page, not a web workspace. Removing the runtime
+  from your account flips it back to the refusal page; `alexandr link` re-links it.
+
+## License
+
+[Apache-2.0](LICENSE).
+
+> **Status:** published to npm as `alexandr` (0.1.0 was the first real release,
+> 2026-08-14, replacing the 0.0.1 name-reservation placeholder). Deployments remain
+> team-delivered per the Enterprise posture above — publishing the mechanics hides
+> nothing, because registration is gated server-side.

package/bin.js

@@ -1,14 +1,9 @@
 #!/usr/bin/env node
-
-// alexandr — name-reservation placeholder. The real CLI lands soon.
-process.stdout.write(`
-  alexandr — self-hosted AI workspace runtime
-
-  This is a placeholder reserving the "alexandr" command.
-  The real CLI is on the way:
-
-      npx alexandr up      # pull + boot the runtime locally (coming soon)
-
-  Track it → https://github.com/alexandrco/alexandr
-
-`);
+// Public entrypoint for the `alexandr` CLI. Keep this a thin shim; logic lives
+// in ./src. Plain Node (no Bun, no deps) so it runs anywhere Node 20+ is.
+import { run } from "./src/cli.js";
+
+run().catch((err) => {
+  process.stderr.write(`${err?.stack || err}\n`);
+  process.exit(1);
+});

package/package.json

@@ -1,31 +1,41 @@
 {
   "name": "alexandr",
-  "version": "0.0.1",
-  "description": "alexandr — the self-hosted AI workspace runtime CLI. Placeholder reserving the name; the real CLI (npx alexandr up → pulls + boots the runtime) is on the way.",
+  "version": "0.1.0",
+  "description": "Run the alexandr workspace runtime locally — a thin Docker front door (npx alexandr up). Pulls + boots the published kernel image.",
   "type": "module",
   "bin": {
     "alexandr": "./bin.js"
   },
+  "scripts": {
+    "check": "node scripts/check.mjs"
+  },
   "files": [
     "bin.js",
-    "README.md"
+    "src",
+    "templates",
+    "README.md",
+    "LICENSE"
   ],
   "engines": {
     "node": ">=20"
   },
-  "license": "UNLICENSED",
+  "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/alexandrco/alexandr.git",
     "directory": "tooling/runtime"
   },
   "homepage": "https://github.com/alexandrco/alexandr#readme",
+  "bugs": {
+    "url": "https://github.com/alexandrco/alexandr/issues"
+  },
   "keywords": [
     "alexandr",
     "self-host",
     "docker",
     "runtime",
     "ai",
-    "workspace"
+    "workspace",
+    "cli"
   ]
 }

package/src/cli.js

@@ -0,0 +1,83 @@
+// Argument parsing, the command table, help, and version. Dispatches to the
+// verb implementations in commands.js.
+
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { parseArgs, log, bold, dim, cyan, fail } from "./util.js";
+import * as cmd from "./commands.js";
+import { resolveInstance, isMaterialized, kernelPort } from "./instance.js";
+import { kernelUrl, version as kVersion } from "./probe.js";
+import { COMMANDS, completion } from "./completion.js";
+import { EXIT } from "./exit.js";
+
+const pkg = JSON.parse(
+  fs.readFileSync(path.resolve(fileURLToPath(import.meta.url), "..", "..", "package.json"), "utf8"),
+);
+
+// The COMMANDS block, formatted from the single command registry so help and
+// completion can never drift apart.
+const commandLines = COMMANDS.map((c) => `  ${c.usage.padEnd(13)} ${c.summary}`).join("\n");
+
+const HELP = `${bold("alexandr")} — deploy and operate an alexandr workspace runtime
+
+${bold("USAGE")}
+  alexandr <command> [options]
+  npx alexandr@latest up      ${dim("first run asks its few questions; flags skip them")}
+
+${bold("COMMANDS")}
+${commandLines}
+
+${bold("COMMON OPTIONS")}
+  --port <n>    Loopback kernel port (default 3030)
+  --domain <d>  Expose publicly via Caddy + HTTPS (access = your account sign-in)
+  --name <id>   Target a named global instance (run several side by side)
+  --dir <path>  Target a project instance at <path>
+  --open        Open the workspace in your browser
+  --offline     Don't pull; use the local image
+  --yes, -y     Skip confirmation on destructive commands
+  -h, --help    Show help
+
+${dim("Docs: https://github.com/alexandrco/alexandr  ·  needs Docker")}`;
+
+async function version(flags) {
+  log(`alexandr (cli) v${pkg.version}`);
+  const inst = resolveInstance(flags);
+  if (isMaterialized(inst.dir)) {
+    const v = await kVersion(kernelUrl(kernelPort(inst.dir)));
+    log(v?.version ? `runtime         v${v.version}` : dim("runtime         (not running)"));
+  }
+}
+
+const TABLE = {
+  up: cmd.up, down: cmd.down, destroy: cmd.destroy, status: cmd.status,
+  ls: cmd.ls, logs: cmd.logs, config: cmd.config, init: cmd.init,
+  update: cmd.update, connect: cmd.connect, link: cmd.link, backup: cmd.backup,
+  restore: cmd.restore, completion, doctor: cmd.doctor, version,
+};
+
+export async function run(argv = process.argv.slice(2)) {
+  const flags = parseArgs(argv);
+  const sub = flags._.shift();
+
+  if (!sub || flags.help || flags.h) {
+    if (!sub && (flags.version || flags.v)) return version(flags);
+    log(HELP);
+    return;
+  }
+  if (sub === "help") return void log(HELP);
+  if ((flags.version || flags.v) && sub === "version") {
+    /* fallthrough to version */
+  }
+
+  const handler = TABLE[sub];
+  if (!handler) {
+    fail(`Unknown command '${sub}'. Run \`alexandr --help\`.`, EXIT.USAGE);
+  }
+  try {
+    await handler(flags);
+  } catch (err) {
+    fail(err?.message || String(err));
+  }
+}