@b3labs/b3iq-cli 0.0.0-stage → 0.0.1

package/AGENTS.md

@@ -0,0 +1,319 @@
+# Drive B3IQ machines from an agent
+
+Official B3IQ instructions for a coding agent that manages a customer's GPU
+machines through the `b3iq` CLI. This file ships inside the npm package
+`@b3labs/b3iq-cli`, so you can check where it came from: after install it is at
+`$(pnpm root -g)/@b3labs/b3iq-cli/AGENTS.md`. The human docs are at
+`https://docs.b3iq.org/developers/cli`, and every docs page has a Markdown
+version at the same URL plus `.md`.
+
+## Rules for the agent
+
+1. Run the commands yourself. The exceptions are marked **User step**: they need
+   a browser or the dashboard, so ask the user and wait.
+2. Never run a command that waits on a prompt or never exits. See
+   [Commands that block](#commands-that-block).
+3. Reads are safe to run at any time. Ask the user before anything under
+   [Change a machine](#change-a-machine): it installs, removes or restarts
+   software on a real box that may be serving traffic.
+4. Report what you verified. Don't mark a step done that you could not confirm.
+
+## Set up
+
+Every command here is safe to re-run.
+
+```bash
+pnpm add -g @b3labs/b3iq-cli  # Node 22.23.4+ (22.x) or 24.22.1+ (24.x)
+b3iq --version
+```
+
+> **User step.** Ask the user to create an API key in the dashboard under
+> **Keys → API keys** with **Machines & SSH** access, and put it in your
+> environment as `B3IQ_TOKEN`. Don't run `b3iq login` yourself: it opens a
+> browser and waits.
+
+```bash
+export B3IQ_TOKEN=...
+b3iq doctor --json              # {"checks":[{"name","ok","detail"}]}
+b3iq machines list --json       # an array; [] is a pass on an account with no machines
+```
+
+`doctor` checks `config`, `auth`, `cloudflared` and `api`, and exits `2` when any
+check fails. A failed `cloudflared` check only matters for `b3iq ssh`.
+
+Three token facts that cost time:
+
+- An API key with only inference access is for `inference` and `mcp media` requests.
+  Machine-management commands need a Machines & SSH key or the key `b3iq login`
+  saves. A CLI token (`b3iq_pat_`) was retired: it gets a `401` with
+  `diagnostic` `token_retired`.
+- A personal key sees the user's own account. Setting `B3IQ_ORG_ID`
+  with one is refused (exit `3`, `diagnostic` `org_scope_unsupported`). Unset it.
+  That does not grant organization machines. If another account manages the
+  machine, B3IQ support (hello@b3iq.org) can grant this account owner access. A
+  missing match is not itself proof that grant is the problem.
+- An organization's machines need an organization login. **User step:** ask the user to
+  run `b3iq login` in their own terminal (it opens a browser and waits) and pick
+  the organization on the approval page, or to give you the token it saved. That
+  token is an API key (`b3iq_key_`) bound to the org. `b3iq whoami --json` then shows
+  `organization`. The key reaches only its organization, carries the user's
+  org role for machines and nothing else, and expires after 90 days or when the
+  user leaves the org (then a `401`). `models list` without `--machine` and `logs`
+  need a personal login; `status` then shows the machines alone.
+
+Report the result in this shape, one line per check, `✓` verified, `⚠` needs the
+user, `✗` failed. Follow it with the next action for every line that is not `✓`.
+
+```
+B3IQ agent setup
+  ✓ cli          b3iq 0.1.0
+  ✓ auth         reachable as user@example.com
+  ⚠ cloudflared  not installed, needed for b3iq ssh
+  ✓ machines     2 found
+```
+
+## Contract
+
+Native coding clients use `b3iq inference codex|claude|opencode --model <exact-served-id>`
+from the user's chosen project directory. Read the native-client section in
+[README.md](./README.md) before setup. Inference uses `B3IQ_GATEWAY_API_KEY` or
+the private saved API key, not `B3IQ_TOKEN`. Never invoke
+`b3iq inference credential` in an agent-captured command: it deliberately writes the
+secret to a native client's private pipe.
+
+- **stdout is data, stderr is logs.** Parse stdout. Progress lines and hints never
+  touch it.
+- **JSON is automatic when piped.** If stdout is not a TTY, every command emits
+  JSON. `--json` forces it, `--pretty` forces the table, and the two together
+  exit `1`.
+- **`--quiet` prints only ids**, one per line.
+- **Exit codes are stable:** `0` ok · `1` usage · `2` api · `3` auth ·
+  `4` rate-limited. Branch on these, not on message text.
+- **Errors are JSON too.** In JSON mode a failure writes one line to stderr:
+  `{"error","code","request_id","diagnostic","cause","observed","recovery","limitation","command_id"}`.
+  `error`, `code`, and `request_id` are the old keys. Branch on `code` and the
+  exit code, not on message text. `cause` is only what that command checked.
+  `recovery` is copyable next steps. Give `request_id` or `command_id` to the
+  user when they contact support. Do not treat a missing machine as proof the
+  id does not exist: `diagnostic` `machine_not_visible` means it was not in this
+  account's list. Do not set `B3IQ_ORG_ID` to widen that list. A personal key
+  cannot take organization scope; an org login's API key (an organization picked
+  at `b3iq login`) lists only its organization's machines.
+- **Rate limits retry once.** A `429` is retried after 1 s, then exits `4`.
+- **Env beats the config file.** `B3IQ_TOKEN`, `B3IQ_API_URL` and `B3IQ_ORG_ID`
+  override `~/.b3iq/config.json`. The saved org goes with the saved token only: with
+  `B3IQ_TOKEN` set, no saved `org_id` is sent. `B3IQ_CONFIG_DIR` replaces `~/.b3iq`; anything the
+  CLI saves goes through `configDir()`, never `homedir()` directly.
+- **The login link follows the control plane.** The approval link opens the
+  dashboard that belongs to `B3IQ_API_URL`, or `B3IQ_DASHBOARD_URL` when set.
+
+## Read a machine
+
+```bash
+b3iq status --json | jq '{machines_total, machines_online, models_servable}'
+b3iq machines list --quiet                       # node ids, one per line
+b3iq machines list --json | jq -r '.[] | select(.serving == "not_serving") | .node_id'
+b3iq machines get my-box --json | jq '{id: .node.node_id, liveness, state, serving,
+  reasons: .health.qualification.reasons, plugins, blockers: .routing.blockers}'
+b3iq plugins list --machine my-box --json        # [] on a machine with monitoring only
+b3iq commands list --machine my-box --json       # what was asked of it, newest first
+b3iq machines guests my-box --json | jq '.guests[] | {guest_id, kind, state}'
+```
+
+`machines guests` reads a KVM host, where each rental runs in its own virtual
+machine (a guest) holding every GPU. Its owner sees every card and the guests
+on it now (`access: machine`); the renter sees their own guest and the way in
+(`access: guest`, with `ssh_user` and `ssh_hostname`). Any other machine
+answers `host_role: host` and no guests.
+
+`machines get --json` nests the node record: the id is `.node.node_id`, not
+`.node_id`. The list rows carry `node_id` at the top level.
+
+| Field | Values | Meaning |
+|---|---|---|
+| `liveness` | `online` `degraded` `offline` | whether the machine is reporting |
+| `state` | `NEW` `QUALIFYING` `HEALTHY` `SUSPECT` `FAIL` or `null` | the machine's own hardware verdict |
+| `serving` | `serving` `serving_with_warnings` `not_serving` `no_verdict` | whether that verdict lets it take traffic |
+| `health.qualification.reasons` | strings, for example `xid_critical`, `floor_uplink` | why the state is not `HEALTHY` |
+| `provisioning` | `{failed, stage, reason, at}` | first-boot outcome; `stage` is `done` once provisioned |
+| `plugins` | `[{name, version, state, reason?}]` | `[]` on a machine with monitoring only |
+| `rental` | `{active}` or `null` | non-null while a rental holds the machine |
+| `ssh_lane` | `{enabled, hostname}` | detail only; `b3iq ssh` needs `enabled: true` |
+| `ssh_direct` | `{addresses, port}`, `null` or absent | detail only, not served yet; where the box's own sshd takes connections. `b3iq ssh` uses it only with the `cli_direct_ssh` feature |
+
+Check `serving` before you trust a benchmark or a training run on a machine.
+`serving_with_warnings` means a slow uplink, a slow disk or a hot card: the
+machine works, and `reasons` names what to look at. `not_serving` means a fault
+such as an ECC error, a critical Xid or a missing card.
+
+A machine boots with monitoring only. Models and runtimes belong to the
+`inference` plugin, so until it is installed `models list --machine` and
+`runtimes list` return `[]`. A plugin's `state` is one of `installing`,
+`starting`, `ready`, `paused`, `degraded`, `down` or `failed`.
+
+## Run a command on the box
+
+An agent's stdout is never a TTY, so `b3iq ssh` **prints** the `ssh` invocation
+and runs nothing. Run it yourself:
+
+```bash
+b3iq ssh my-box --json -- nvidia-smi > ssh.json
+jq '{transport, hostname, user}' ssh.json
+log=$(mktemp)
+eval "ssh -E $log -o LogLevel=DEBUG1 -o ControlPath=none -o BatchMode=yes $(jq -r '.ssh_args | @sh' ssh.json)"
+rc=$?
+grep -Ev '^(debug|Authenticated to|Transferred|Bytes per second)' "$log" >&2
+if [ "$rc" = 255 ] && ! grep -q '^Authenticated to' "$log" && jq -e .fallback ssh.json >/dev/null; then
+  eval "ssh -o BatchMode=yes $(jq -r '.fallback.ssh_args | @sh' ssh.json)"
+  rc=$?
+fi
+rm -f "$log"
+(exit "$rc")
+```
+
+The block exits with the remote command's code, or `255` when `ssh` itself failed;
+`ssh`'s own messages (`Permission denied`, `Host key verification failed.`) go
+to stderr. A `255` also comes from a remote command that exits `255`, or a link
+that drops after the command started. The log tells them apart: run `fallback`
+only when the first run never logged in, or the command runs twice.
+`ControlPath=none` keeps a `ControlMaster` in your SSH config from turning the
+first run into a mux client, which never logs `Authenticated to`.
+
+`BatchMode=yes` makes `ssh` fail instead of asking for a password. Everything
+after `--` is the remote command and is already inside `ssh_args`. Always name
+the machine: with no machine and no default, a piped `b3iq ssh` exits `1`
+instead of asking.
+
+`b3iq ssh` exits `1` with the reason when the machine is not ready for it:
+
+> **User step.** The SSH lane is off until the user enables it on the machine's
+> dashboard page, and their public key has to be listed under
+> **Keys → SSH keys**.
+
+`transport` is `cloudflared` or `bastion`, or `direct` when the account has
+the `cli_direct_ssh` feature. `cloudflared` needs `cloudflared` on your side
+(`b3iq doctor` checks it); `bastion` is plain `ssh` with a jump host. `direct`
+is plain `ssh` to an address the machine reported, chosen only when its sshd
+answered a probe just now; `fallback` then holds the tunnel invocation to run
+only when the first run exits `255` before it logged in, and is `null`
+otherwise. `--tunnel` skips the direct path. `--direct` uses nothing else and
+exits `1` (`diagnostic` `ssh_direct_not_enabled`, `ssh_direct_unavailable`,
+`ssh_direct_unreachable` or `ssh_direct_not_for_guests`) when it can't.
+Connect once without `--direct` first: the direct path only accepts a host key
+the tunnel already saved.
+`cli_direct_ssh` is not available to a `b3iq login` yet: every login saves an
+API key, and `/v1/public/features` answers an API key as signed out, so a
+per-account grant does not reach the CLI.
+`user` is the account `ssh_args` logs in as: `b3iq` on a machine you hold. On a
+KVM host you rent, `b3iq ssh` opens your guest instead: `user` is the guest's
+(`renter`), the JSON adds `guest_id`, and it exits `1` while the guest is not
+ready yet.
+
+### On the box, `b3iq` is a different program
+
+The box has its own CLI, `b3iq-host`, also installed there under the name `b3iq`.
+It manages that one machine and knows nothing about your token. Call it
+`b3iq-host` in remote commands so the two never get mixed up.
+
+```bash
+b3iq-host status --json            # identity, enrollment, paths
+b3iq-host doctor --json            # local service and each plugin's state
+sudo b3iq-host plugin list         # installed plugins, version, state
+nvidia-smi --query-gpu=index,name,temperature.gpu,power.draw --format=csv
+```
+
+Those four read. To change a plugin, use `b3iq plugins` from your side (next
+section) so the change is queued, tracked and visible in the dashboard.
+
+## Change a machine
+
+Ask the user before any of these.
+
+```bash
+b3iq plugins list --json                        # what a machine can install
+b3iq plugins install inference --machine my-box # adds the inference API, no engine or model
+b3iq plugins remove inference --machine my-box  # removes it with its engines and models
+
+b3iq models list --machine my-box --json        # each profile's status
+b3iq models install <model> --machine my-box
+b3iq models context <model> --machine my-box    # allocate/verify coding context; changes runtime memory
+b3iq models remove <model> --machine my-box
+b3iq runtimes restart <runtime> --machine my-box
+
+b3iq machines qualify my-box                    # re-run the hardware qualification
+```
+
+`models install` takes a model whose status is `ready_to_install`, `models
+remove` one that is `installed`. Any other status exits `1` and names the status
+it found.
+
+A plugin change is refused (exit `2`) when the caller does not control the
+machine. In `earn` mode nobody does, and during a rental the renter does.
+
+`machines qualify` reports that the run finished, not what it found. Read the
+verdict afterwards from `state`, `serving` and the reasons on `machines get`.
+
+## Commands that block
+
+| Command | What it does | Use instead |
+|---|---|---|
+| `b3iq login` with no token | waits for a browser approval on a TTY, exits `1` without one | `B3IQ_TOKEN` |
+| `b3iq logs --follow` | never exits | `b3iq logs --limit 200 --json` |
+| `b3iq ssh <machine>` on a TTY with no command | opens an interactive shell | the recipe above |
+| `b3iq models install` | waits up to 45 minutes | `--no-wait` |
+| `b3iq plugins install` | waits up to 25 minutes | `--no-wait` |
+| `b3iq plugins remove`, `b3iq machines qualify` | wait up to 10 minutes | `--no-wait` |
+| `b3iq models remove`, `b3iq runtimes restart` | wait up to 5 minutes | `--no-wait` |
+| `b3iq models context` | waits up to 6 minutes for allocation and verification | `--no-wait` |
+
+`--no-wait` returns `{"command_id","type","status":"queued"}` at once. Read it
+back until `status` is `completed`, `failed` or `cancelled`:
+
+```bash
+b3iq commands get <command-id> --machine my-box --json | jq '{status, error, progress}'
+```
+
+## Machine selectors
+
+Any `<machine>` accepts a node id, an id prefix, or a case-insensitive substring
+of the machine's name. An exact id or name wins. A selector that matches more
+than one machine exits `1` and lists the candidates. `b3iq config
+default-machine <id>` sets the machine used when the argument is left out. A KVM
+host you rent is not in `machines list`; `ssh` and `machines guests` look in
+your rentals when no machine you hold matches.
+
+## Native inference and media
+
+Inference uses a dashboard API key supplied as `B3IQ_GATEWAY_API_KEY` (or saved
+privately with `b3iq inference key-save`), separate from the machine-management
+token. `b3iq inference models` discovers the exact served ids available to that
+key; use one of those, never a guess. `b3iq inference codex|claude|opencode
+--model <id>` launches the terminal client from the user's project directory, and
+`inference setup <client> --model <id>` only writes private configuration and
+reports the paths. Never invoke `b3iq inference credential` in a captured
+command: it deliberately writes the secret to a native client's private pipe.
+
+Desktop setups are experimental and opt-in. `setup codex --desktop --install`
+saves a separate macOS Codex instance with its own settings and history;
+`setup claude --desktop --install` saves an inactive Claude desktop connection;
+`setup opencode --desktop --install` merges persistent OpenCode settings with a
+backup. OpenCode setup targets major version 2 by default; pass `--client-version 1`
+for version 1. Only `--activate` switches a desktop client over, and
+`inference restore claude --desktop` switches it back. Never merge a setup's
+exports into a client's global settings or change the user's normal model or
+provider defaults yourself.
+
+Setup needs a served text model with `tool_calling` and a verified context window
+of at least 32K for Codex and OpenCode or 100K for Claude Code. `b3iq models
+context` sets the window; it changes runtime memory on the machine, so it belongs
+under [Change a machine](#change-a-machine) and needs the user's go-ahead.
+
+`b3iq mcp media` exposes model discovery, image and video generation and video
+status over stdio. It uses the same API key and requires a served model of the
+requested modality. The API key does not authenticate GitHub or authorize local
+coding tools; those use the native client's own settings and permissions.
+
+## Not covered here
+
+- **A burn test.** `machines qualify` re-reads the hardware. It does not load
+  the GPUs, so it cannot clear a finding from a burn.

package/ERROR_PATHS.md

@@ -0,0 +1,63 @@
+# CLI failure map
+
+A failure prints what the CLI checked, the values that check actually saw, and a
+next step. In JSON mode it writes one object to stderr with `error`, `code` and
+`request_id`, plus `diagnostic`, `cause`, `observed`, `recovery` and `limitation`
+when a path has them. No color and no `✗` in that object. Exit codes stay `0` ok,
+`1` usage, `2` api, `3` auth, `4` rate-limited.
+
+`cause` is only a check this process made. A failed follow-up lookup is noted
+and does not replace the original error. Nothing in these paths changes context,
+permissions or defaults, or restarts a service.
+
+| `diagnostic` | What the CLI checked | Next step |
+| --- | --- | --- |
+| `context_window_insufficient` | Gateway `context_window_tokens` is an integer below 32768 (Codex, OpenCode) or 100000 (Claude Code). Tool calling and input modalities are reported beside that. | `b3iq models context` only when the personal machine list contains exactly one match. Otherwise `b3iq whoami` and `b3iq machines list`. |
+| `context_metadata_missing` | `context_window_tokens` was absent, null, or not a safe integer. The minimum is not applied. | Same management check as a short window. This is not described as a small window. |
+| `modality_metadata_missing` | `modality` was absent. Window and tool-calling checks are not applied. | `b3iq inference models` |
+| `modality_unsupported` | `modality` was present and not `text`. | `b3iq inference models`. Not `models context`. |
+| `tool_calling_missing` | Window meets the minimum and `tool_calling` was not in `capabilities`. | `b3iq inference models`. Context configuration does not add tool calling. |
+| `model_not_served` | The id was not in the discovery list. Count is the list length. | `b3iq inference models` |
+| `machine_not_visible` | Personal machine list, and for ssh the rental list, had no match. Account email is included when settings answered. | `b3iq whoami`, `b3iq machines list`. Support can grant owner access; the message does not assert that is the cause. |
+| `machine_ambiguous` | More than one personal-list match. | Full node id, or `b3iq machines get` for a short candidate list. |
+| `machine_selector_missing` | No argument and no `default_machine`. | `b3iq machines list`, `b3iq config default-machine` |
+| `model_not_on_machine` | Catalog had profiles and none matched. | `b3iq models list --machine` |
+| `model_ambiguous` | More than one profile on the machine matched the selector with the status the command needs. | Pass the full profile id. |
+| `model_not_ready` | Catalog status was none of the rows below for a command that needs `installed` or `ready_to_install` (for example `installing` or `failed`). | `b3iq models list --machine`, then `b3iq machines get` |
+| `model_catalog_offline` | Catalog was empty and list liveness was `offline`. No command was queued. | `b3iq machines get`, then `b3iq models list` |
+| `model_not_installed` | Status was `ready_to_install` for a command that needs `installed`. | `b3iq models install` |
+| `model_already_installed` | Status was `installed` for install. | `b3iq models list` |
+| `runtime_missing` | Catalog status `runtime_missing`. | `b3iq runtimes list` |
+| `hardware_unsupported` | Catalog status `hardware_unsupported`. | No hardware command exists here. |
+| `modality_unsupported` on a catalog row | Catalog status `modality_unsupported`. Distinct from the gateway modality check above. | `b3iq models list` |
+| `runtime_not_on_machine` | Runtime id was not on the machine. | `b3iq runtimes list` |
+| `ssh_lane_disabled` | `ssh_lane.enabled` or hostname was missing. Hostname value is not printed. | Enable the lane on the machine dashboard page. |
+| `cloudflared_missing` | `cloudflared --version` did not exit 0. | `brew install cloudflared`, `b3iq doctor` |
+| `ssh_missing` | Starting `ssh` failed with ENOENT. | Install an OpenSSH client, `b3iq doctor` |
+| `ssh_direct_not_enabled` | `--direct` was given and `cli_direct_ssh` was not among the account's features, or they could not be read. The feature is not available to a `b3iq login` yet. | `b3iq ssh <machine>`, or `--tunnel` |
+| `ssh_direct_unavailable` | `--direct` was given and machine detail had no `ssh_direct` addresses. | `b3iq ssh <machine>` |
+| `ssh_direct_unreachable` | `--direct` was given and no reported address answered with an SSH banner. | `b3iq ssh <machine>` |
+| `ssh_target_invalid` | A hostname, address, user or port the control plane returned is not plain (ssh would hand it to a shell). Nothing was started. | `b3iq machines get <machine> --json`; report the `request_id` to support. |
+| `ssh_direct_not_for_guests` | `--direct` was given for a rented guest, which is only reachable over its host's tunnel. | `b3iq ssh <machine>` |
+| `auth_missing` | No token in `B3IQ_TOKEN` or `~/.b3iq/config.json`. | `b3iq login` |
+| `auth_rejected` | HTTP 401. Body is redacted. | `b3iq login`. An inference-only API key does not log machine commands in. |
+| `token_retired` | HTTP 401 whose detail says CLI tokens (`b3iq_pat_`) were retired. | `b3iq login` |
+| `login_expired` | HTTP 401 after the saved login's `expires_at`. | `b3iq login` |
+| `org_scope_unsupported` | HTTP 403 whose detail says the personal key is personal-scope. | Unset `B3IQ_ORG_ID` and config `org_id`. Unsetting does not grant organization machines; `b3iq login` with the organization chosen in the browser does. |
+| `org_token_mismatch` | HTTP 403 whose detail says the API key is bound to a different organization. | Unset `B3IQ_ORG_ID`, or `b3iq login` and choose the other org. |
+| `auth_forbidden` | Other HTTP 403. Not relabeled as the personal-scope refusal. | `b3iq whoami` |
+| `network_failed` | `fetch` threw before a status. The transport message is omitted. | `b3iq doctor` |
+| `request_timeout` | `TimeoutError` or `AbortError` before a status. | Retry. This is not a failed remote command. |
+| `rate_limited` | HTTP 429 after the one control-plane retry. | Wait and retry the same command. |
+| `api_rejected` | Other control-plane HTTP error. Structured `detail` only. | Retry. Include `request_id` for support. |
+| `gateway_auth_rejected` | Inference HTTP 401 or 403. Body not printed. | API key, not `B3IQ_TOKEN`. |
+| `gateway_machine_not_found` | Inference HTTP 404 with a machine pin. | `b3iq inference models`, `b3iq machines list`. The status is not treated as proof the id is wrong. |
+| `gateway_rate_limited` | Inference HTTP 429. This call is not retried. | Wait and retry. |
+| `gateway_http_error` | Other inference HTTP status. Body not printed. | `b3iq inference models` |
+| `command_timeout` | Poll ended with no `completed`, `failed`, or `cancelled` status. Last seen status is included when a row was seen. | `b3iq commands get <id> --machine <id>`. Do not submit a duplicate yet. |
+| `command_failed` | Status `failed`, plus the server error text when present. | `b3iq commands get` before another submit. |
+| `command_cancelled` | Status `cancelled`. | `b3iq commands get` |
+
+An offline machine that still has an eligible profile is not refused: the CLI
+warns and still submits the command. JSON and human rendering redact
+`b3iq_key_…`, `b3iq_pat_…`, `sk-…` and `Bearer` values.

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.