mirab 0.0.0 → 0.2.0

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 [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,7 +1,227 @@
 # mirab
 
-Virtual machines and agents for Addis: the VM and agent primitive behind gild.
+Agents in VMs on your own machine.
 
-This version only reserves the name. The first release is coming.
+An agent is a folder: its instructions, tools and skills. mirab runs the
+whole agent (its loop, its tools and every command it picks) inside a VM on
+your hardware, and the agent never holds a credential: model calls and other
+outside requests leave through the station on the host, which adds the key
+from [harar](https://github.com/addiscorp/harar) on the way out. Agents meet
+people in channels, inside the apps they help with.
 
-Siblings: [woreda](https://www.npmjs.com/package/woreda) (Actions runners) and [kebele](https://www.npmjs.com/package/kebele) (containers).
+> **Status: early.** This is mirab's agent system, moved over with its
+> history: VMs through Apple's Virtualization framework (`vz`) and
+> Firecracker, containers, `mirab spawn`, and the Claude and Codex adapters.
+> `mirab init`, `mirab dev` and the station are in; channels come next.
+
+## Install
+
+```sh
+curl -fsSL https://mirab-releases.addis.gg/install.sh | sh
+```
+
+It installs mirab into `~/.mirab` (the release in `~/.mirab/releases/`, the
+`mirab` command in `~/.mirab/bin`), checked against the SHA-256 in the
+release's manifest, with no sudo. It brings its own Bun, and on Linux its own
+Firecracker. The VM image is downloaded on first use. Builds: macOS (Apple
+silicon and Intel) and Linux x86_64. `sh -s -- --canary` installs the newest
+build of `main`.
+
+## Make an agent
+
+```sh
+mkdir ops && cd ops
+mirab                                           # asks for the agent's harar name
+# or: mirab init ops --name gg.addis.agent.ops
+```
+
+It writes `agent/agent.ts`, `agent/instructions.md`, and `tools/`, `skills/`,
+`subagents/`, `schedules/` and `channels/` folders. It never writes a `.env`:
+model access comes from harar.
+
+## Run it
+
+```sh
+mirab dev            # in the project: a chat with the agent, in its own VM
+mirab manifest       # what mirab reads about the agent, as JSON
+```
+
+The VM has no network of its own. Its only way out is the station on this
+machine, which lets it reach the domains in `agent.ts` (`domains`) and adds
+the model key, sent by harar for that host only, on the way out. Nothing in the VM holds the
+key. `~/.config/mirab/station.json` says where harar is and which secret is
+the key:
+
+```json
+{
+  "harar": { "socket": "/var/run/harar.sock" },
+  "models": {
+    "anthropic": { "key": "personal/anthropic/API_KEY" },
+    "claude": { "token": "personal/claude/OAUTH_TOKEN" }
+  }
+}
+```
+
+Like any key, harar decides where these go, and records each time:
+
+```sh
+harar hosts allow personal/anthropic/API_KEY api.anthropic.com
+harar hosts allow personal/claude/OAUTH_TOKEN api.anthropic.com
+```
+
+While `mirab dev` runs, what you save reaches the agent's VM, and the agent
+picks up edits to `agent/` before its next turn, keeping the conversation.
+When the session ends, what the agent changed comes back to your project. If
+you both changed the same file, yours stays and the agent's is saved aside,
+never merged and never silently dropped. Your `.git` is never touched. What
+the agent changes about itself (anything under `agent/` and every `.env*`)
+never lands on its own: it's held aside and named when the session ends, for
+you to look at and copy over if you want it.
+
+That alone can't stop an agent widening itself (its code may import from
+elsewhere), so what it may reach is approved per project, not taken from its
+code: the first `mirab dev` records the manifest's `domains` and `packages`,
+and if its code later asks for more, by any route, the new ones are left out
+of the session and named. If the change was yours, approve it here:
+
+```sh
+mirab manifest           # what the agent asks for (read in its VM), and what's waiting
+mirab manifest approve   # yes to what's waiting
+```
+
+What the agent's calls may do is rixse's to decide. A host a key goes to lets
+reads (GET, HEAD) through and holds everything else for you, unless the
+agent's `gateway` section says otherwise:
+
+```ts
+export default defineAgent({
+  name: 'gg.addis.agent.ops',
+  model: 'anthropic/claude-sonnet-5-5',
+  gateway: {
+    rules: [
+      // apply: goes through; request: held for you; forbidden: never.
+      { host: 'github.com', method: 'POST', path: '/acme/repo.git/git-receive-pack', effect: 'apply' },
+      { host: 'api.stripe.com', method: 'DELETE', effect: 'forbidden' },
+    ],
+    // Optional: a separate key used only for sends you approve, so a read key can't write.
+    secrets: { 'api.stripe.com': { agent: 'prod/shop/READ', approved: 'prod/shop/WRITE' } },
+  },
+})
+```
+
+The section is approved as a whole, like the rest: the first `mirab dev`
+records it, and any change after that, even one that looks narrower, waits
+for `mirab manifest approve`, which shows every rule. Until then the approved
+one stays in force.
+
+The chat is a channel the station hosts, between you and the agent, and it
+stays on this machine (`~/.mirab/sessions/channels`, readable only by
+you). `mirab dev` prints its id when it starts. In it you are `station.json`'s
+`human` (your harar name, like `gg.addis.human.sami`), or your login in the
+agent's org until you set one. Later the same chat can live in an app.
+
+The agent's files run only in its VM, never on this machine: the manifest is
+read there and checked here. The VM can spend the model key
+on its route (that is what the route is for), but never read it.
+
+mirab runs on [Bun](https://bun.sh), and so do the agents it makes (their
+`agent/` files are TypeScript, run as is).
+
+## Claude Code on your own subscription
+
+`mirab spawn --vm claude` runs Claude Code in a VM on your Claude
+subscription, and the VM never holds your token. Make a token once with
+`claude setup-token`, keep it in harar
+(`harar put personal/claude/OAUTH_TOKEN`), and name it under `models.claude`
+in `station.json`. In the VM, Claude Code has a placeholder token and the
+station as its API. The station swaps in your token on the way to
+`api.anthropic.com/v1/messages`, and nothing else leaves: Claude Code's
+telemetry and updates are off, and anything else it tries goes through the
+station's whitelist and audit log. One person's token, on their own machine.
+
+## When an agent asks for more
+
+A host that isn't in an agent's `domains` is refused, and the station
+records the ask on this machine. You decide in your own terminal, never in
+the agent's VM:
+
+```sh
+mirab escalations              # what agents asked for
+mirab allow api.stripe.com     # yes: the running station lets it through at once
+mirab dismiss api.stripe.com   # no
+mirab revoke api.stripe.com --agent project:$PWD   # take a yes back (a project is its folder)
+```
+
+Quote wildcards so the shell leaves them alone: `mirab allow '*.example.com'`.
+
+A yes goes into that agent's allow file in `~/.config/mirab/allow/`. To
+keep it, add the host to `domains` in `agent/agent.ts`, so it lives in git.
+
+## Packages
+
+An agent's `packages` (apt names, in `agent.ts`) are installed on mirab's
+Ubuntu base image the first time it runs, then cached:
+
+```sh
+mirab image build     # build the agent's image now (mirab dev does it on first use)
+mirab image update    # boot it, and upgrade it if apt has anything newer
+mirab image list      # the images cached on this machine
+mirab image prune     # remove ones on an older base, unused 30 days, or left by a stopped build
+```
+
+Building and updating happen in a mirab VM whose only way out is the station, with only
+Ubuntu's mirrors on its whitelist, over HTTPS. An update keeps the image
+before it, for rollback. The same on macOS and Linux.
+
+## Keys for any service
+
+Your project's `.env` holds only references (`harar import .env` writes
+them): `STRIPE_KEY=harar://prod/shop/STRIPE_KEY`. harar says where each secret may
+go, and records each time it does:
+
+```sh
+harar hosts allow prod/shop/STRIPE_KEY api.stripe.com
+harar hosts allow personal/github/TOKEN github.com
+harar hosts allow personal/github/TOKEN api.github.com
+```
+
+At a primary, that's a role's `send` permission
+(`harar policy role set <role> --send "prod/shop/STRIPE_KEY api.stripe.com"`),
+approved like any widening. A secret harar lets go nowhere isn't given to the VM.
+
+A `.env` comes with whatever repo you cloned, so a reference alone gives an
+agent nothing: you let each project use each secret once, here, never in its
+VM. A project is its folder on this machine, never the name its agent gives.
+`mirab dev` and `mirab spawn --vm` print the exact line when one is missing;
+in the project's folder it's just:
+
+```sh
+mirab secrets allow prod/shop/STRIPE_KEY
+mirab secrets list
+mirab secrets revoke prod/shop/STRIPE_KEY
+```
+
+In the VM, `STRIPE_KEY` is a placeholder, new every session. Programs run
+unchanged (`curl`, `git`, `gh`, SDKs), with the station as their proxy. The
+VM trusts the station's own certificate authority (its key stays in
+`~/.config/mirab/station-ca`). For those hosts only, the station opens the
+request, swaps the placeholder in its headers for the real value from harar,
+and sends it on over its own TLS, checking the host's real certificate. A
+placeholder sent to any other host is refused. Bodies and URLs are never
+rewritten, and every other host stays a sealed tunnel. The model never sees a
+key, because the agent never has one.
+
+## Try it
+
+```sh
+bun install
+bun run src/mirab.ts --help
+```
+
+Run it from source for now: a compiled `bun run build` binary can't start
+agents yet, because it needs the PTY module and Firecracker beside it, which
+mirab's packaging will put there.
+
+## License
+
+[Apache-2.0](LICENSE)

package/package.json

@@ -1,11 +1,60 @@
 {
   "name": "mirab",
-  "version": "0.0.0",
-  "description": "Virtual machines and agents for Addis: the VM and agent primitive behind gild. Placeholder; the first release is coming.",
+  "version": "0.2.0",
+  "type": "module",
+  "scripts": {
+    "dev": "bun run src/mirab.ts",
+    "build": "bun build --compile --minify src/mirab.ts --outfile dist/mirab",
+    "test": "bun test",
+    "vm:image": "bun run scripts/build-vm-image.ts",
+    "typecheck": "tsc --noEmit",
+    "types": "rm -rf types && tsc -p tsconfig.types.json",
+    "format": "prettier --write src scripts",
+    "format:check": "prettier --check src scripts"
+  },
+  "dependencies": {
+    "@ai-sdk/anthropic": "4.0.78",
+    "ai": "7.0.137",
+    "chalk": "^5.6.2",
+    "commander": "^14.0.1",
+    "inquirer": "^12.9.4",
+    "node-pty": "1.2.0-beta.15",
+    "smol-toml": "^1.9.0",
+    "zod": "^4.6.5",
+    "rixse": "^0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "bun-types": "^1.3.1",
+    "prettier": "3.9.9",
+    "typescript": "^7.0.2"
+  },
+  "description": "Agents in VMs on your own machine",
   "license": "Apache-2.0",
-  "author": "Addis",
-  "homepage": "https://addis.gg",
-  "keywords": ["vm", "microvm", "agents", "firecracker", "sandbox"],
-  "main": "index.js",
-  "files": ["index.js", "README.md"]
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/addiscorp/mirab.git"
+  },
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "default": "./src/index.ts"
+    },
+    "./tools": {
+      "types": "./types/tools.d.ts",
+      "default": "./src/tools.ts"
+    },
+    "./runner": {
+      "types": "./types/runner/index.d.ts",
+      "default": "./src/runner/index.ts"
+    }
+  },
+  "files": [
+    "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.e2e.test.ts",
+    "types",
+    "README.md",
+    "LICENSE"
+  ]
 }