metergraph-cli 0.0.0-stage → 0.1.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,3 +1,411 @@
-# Temporary Holding Version
+# metergraph-cli
 
-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 Metergraph command line tool. This is a **development preview** (version 0.1.0).
+
+Install the preview channel with npm or run it directly:
+
+```sh
+npx --yes metergraph-cli@next --help
+npx --yes metergraph-cli@next doctor --json
+npm install -g metergraph-cli@next
+```
+
+The installed command is `metergraph`. Pin `metergraph-cli@0.1.0` when you need
+this exact preview. Authentication and hosted setup are not included yet.
+
+This preview does two things:
+
+- `doctor` checks whether a Metergraph service is reachable, healthy and supported.
+- `skill install` and `skill update` copy the Metergraph agent skill bundled with the
+  CLI into one coding agent's project skill directory.
+
+It does not sign in or connect a workspace, and it does not query workspace
+telemetry or send application data. Sign in, workspace binding and hosted setup commands are planned as separate
+follow-up releases and are not part of this package yet.
+
+## Requirements
+
+| | Supported |
+| --- | --- |
+| Node.js | 22 and 24 |
+| Operating systems | Linux, macOS and Windows (each in the CI matrix) |
+| Runtime dependencies | None |
+
+## Commands
+
+```sh
+metergraph --help [--json]
+metergraph help doctor [--json]
+metergraph --version [--json]
+metergraph doctor [--url ORIGIN] [--timeout-ms N] [--json]
+metergraph help skill [--json]
+metergraph skill install --client CLIENT --runtime RUNTIME [--project DIR] [--json]
+metergraph skill update --client CLIENT --runtime RUNTIME [--project DIR] [--json]
+```
+
+`--help`, `--version` and the `skill` commands work offline and make no network
+requests.
+
+### doctor
+
+`doctor` sends three unauthenticated, read-only `GET` requests to one origin, in order,
+and stops at the first problem:
+
+1. `/healthz` must answer `200` with the JSON body `{"ok": true}`.
+2. `/v1/deployment` must answer `200` with a JSON `deployment_profile` this CLI supports.
+3. `/v1/agent/capabilities` must answer `401` with a `WWW-Authenticate: Bearer` challenge.
+
+Options:
+
+| Option | Default | Notes |
+| --- | --- | --- |
+| `--url ORIGIN` | `https://app.metergraph.dev` | Bare origin only, see [Safe origins](#safe-origins). |
+| `--timeout-ms N` | `5000` | Whole number from 100 to 30000. Covers the whole probe, not each request. |
+| `--json` | off | Print exactly one JSON line on stdout and nothing on stderr. |
+
+A healthy, supported service exits with code **3, `authentication_required`**. That is
+the best result this preview can report: the service is reachable, but this CLI holds
+no credentials, so `authenticated` is always `false` and `workspace` is always `null`.
+A reachable service is not a working workspace connection. To connect an application,
+follow the [connection guide](https://www.metergraph.dev/docs/guides/agent-access/).
+
+`doctor` never opens a browser, never prompts and never reads stdin, so it is safe in
+scripts and CI.
+
+### skill install and skill update
+
+`skill install` copies the Metergraph skill bundled with this CLI into one client's
+native project skill directory. Both `--client` and `--runtime` are required, so the
+command never guesses where the skill will be used.
+
+| `--client` | Client | Skill file written | Client documentation |
+| --- | --- | --- | --- |
+| `codex` | Codex | `.agents/skills/metergraph/SKILL.md` | [Build skills](https://learn.chatgpt.com/docs/build-skills) |
+| `claude` | Claude Code | `.claude/skills/metergraph/SKILL.md` | [Skills](https://code.claude.com/docs/en/skills) |
+| `cursor` | Cursor | `.cursor/skills/metergraph/SKILL.md` | [Skills](https://cursor.com/docs/skills) |
+
+Each client has its own directory, so installing for several clients never makes one
+overwrite another.
+
+| Option | Default | Notes |
+| --- | --- | --- |
+| `--client CLIENT` | required | `codex`, `claude` or `cursor`. |
+| `--runtime RUNTIME` | required | `local` when the client runs on this machine, `cloud` when it runs in a cloud environment with a shell and a checkout of the project. Recorded, not detected. |
+| `--project DIR` | current directory | Must be an existing directory. Symbolic links in this path are resolved once; nothing below it is followed. |
+| `--json` | off | Print exactly one JSON line on stdout and nothing on stderr. |
+
+What it writes, and nothing else:
+
+1. The skill file in the table above, plus any of its missing parent directories.
+2. `.metergraph/skill-installations.json`, a small ownership receipt. For each client it
+   records the relative skill path, the skill name, the source revision and SHA-256,
+   and the runtimes requested. It contains no credentials, user names or absolute
+   paths, so it is safe to commit.
+
+Ownership rules:
+
+- `install` never replaces a skill it did not install, even one with identical bytes.
+- Running `install` again on an unchanged skill it installed changes nothing.
+- A skill it installed that was edited since is never overwritten, by `install` or by
+  `update`. Restore or remove the file first.
+- `update` is the only way to replace an older revision this CLI installed. There is no
+  force option.
+- A skill file this CLI installed that has gone missing is written again.
+- Symbolic links and other non-regular entries on the skill or receipt path are
+  refused.
+- Files are written to an exclusive temporary file and renamed into place, under a lock
+  file, `.metergraph/skill-installations.lock`. The receipt is written only after the
+  skill file, and a failed receipt write puts the skill file back as it was. If the
+  process is killed between the two writes, the skill is left without a receipt entry,
+  so later runs refuse to touch it, and the lock stays until you delete it.
+- It never changes client settings, MCP configuration, `AGENTS.md`, `CLAUDE.md` or any
+  other file, and keeps the permissions of a file it replaces.
+
+`--runtime cloud` writes the same project file. A cloud client sees it only through
+its own checkout of the project, so commit the file if you installed it elsewhere.
+Writing a skill file in a cloud checkout does not connect MCP, sign in or copy anything
+from your own machine. Local skills do not sync to desktop or cloud apps on their own.
+
+Clients and runtimes that cannot load project skill files get a pointer to the
+[connection guide](https://www.metergraph.dev/docs/guides/agent-access/) with exit code
+6, and nothing is written: `--client claude-desktop`, `--client chatgpt` and
+`--runtime cloud-no-shell` (a cloud runtime without a shell or project checkout).
+
+A successful run exits `0` with `discovery: "pending"` and `authenticated: false`.
+Writing the file does not prove that a client has loaded it. Start or reload the client
+in the project and check that it lists the `metergraph` skill. The skill itself is
+instructions for the agent; it holds no credentials and does not connect a workspace.
+
+#### Bundled skill source
+
+`assets/skill/SKILL.md` is a byte-for-byte copy of the public skill at
+<https://www.metergraph.dev/SKILL.md>. The source has no version number of its own, so
+`assets/skill/manifest.json` records its source URL, size and SHA-256, and a revision
+derived from that hash (`sha256-` followed by the first 12 hex digits). The package
+version is not the skill version. At runtime the CLI checks the bundled file against a
+hash pinned in its code and in the manifest, and refuses to write anything if either
+does not match. It never downloads the skill or runs a remote script. A new skill
+revision ships only in a new CLI release; `skill update` then upgrades projects that
+hold an unchanged earlier revision.
+
+## Exit codes
+
+Exit codes are stable. Changing one is a breaking change.
+
+| Code | Outcome | Meaning |
+| --- | --- | --- |
+| 0 | `ok` | Command succeeded. `doctor` does not return this in this preview. For `skill`, the file is in place; discovery is still pending. |
+| 1 | `internal_error` | Unexpected failure inside the CLI. |
+| 2 | `invalid_input` | Unknown command or argument, or an invalid option value. No request was made. |
+| 3 | `authentication_required` | Service is reachable, healthy and supported, and requires authentication. No workspace is connected. |
+| 4 | `connection_failed` | The origin could not be reached, the connection failed, or the probe timed out. |
+| 5 | `unhealthy` | The service answered but reported that it is not healthy, or answered with a server error. |
+| 6 | `unsupported` | The service answered with a response, deployment profile or status this CLI does not support, or the skill client or runtime cannot use project skill files. Nothing was written. |
+| 7 | `redirect_rejected` | The service answered with a redirect. Redirects are never followed. |
+| 8 | `conflict` | The skill target is not owned by this CLI, was modified, is unsafe, is locked or needs an explicit update. Nothing was changed. |
+| 9 | `filesystem_error` | Project files could not be read or written. Partial changes were rolled back unless the message says otherwise. |
+
+## JSON output
+
+With `--json`, every command prints one line with the same top-level keys:
+
+```json
+{
+  "schema_version": 1,
+  "command": "doctor",
+  "ok": false,
+  "outcome": "authentication_required",
+  "exit_code": 3,
+  "data": {
+    "origin": "https://app.metergraph.dev",
+    "reachable": true,
+    "healthy": true,
+    "deployment_profile": "managed",
+    "profile_status": "supported",
+    "authentication_required": true,
+    "authenticated": false,
+    "workspace": null,
+    "checks": [
+      { "name": "health", "path": "/healthz", "result": "pass", "http_status": 200, "reason": null },
+      { "name": "deployment", "path": "/v1/deployment", "result": "pass", "http_status": 200, "reason": null },
+      { "name": "capabilities", "path": "/v1/agent/capabilities", "result": "pass", "http_status": 401, "reason": "bearer_token_required" }
+    ],
+    "next_action": { "kind": "connection_guide", "url": "https://www.metergraph.dev/docs/guides/agent-access/" }
+  },
+  "error": {
+    "code": "authentication_required",
+    "reason": "bearer_token_required",
+    "message": "The service is reachable and supported, and it requires authentication. No workspace is connected."
+  }
+}
+```
+
+(Shown formatted here. The CLI prints it on a single line.)
+
+- `ok` is `true` only when `outcome` is `ok`. When `ok` is `false`, `error.code` equals
+  `outcome` and `error.reason` is a fixed token such as `timeout`, `invalid_url`,
+  `unrecognized_profile` or `response_too_large`.
+- `profile_status` is `supported`, `unrecognized`, `unavailable` (the server has no
+  `/v1/deployment` endpoint) or `unknown` (not checked).
+- Checks that did not run have `result: "skipped"`.
+- `--help --json` includes the command list and the exit code table.
+
+A successful `skill install`:
+
+```json
+{
+  "schema_version": 1,
+  "command": "skill install",
+  "ok": true,
+  "outcome": "ok",
+  "exit_code": 0,
+  "data": {
+    "client": "claude",
+    "runtime": "local",
+    "path": ".claude/skills/metergraph/SKILL.md",
+    "status": "installed",
+    "source": {
+      "name": "metergraph",
+      "revision": "sha256-90f7d8d78a5b",
+      "sha256": "90f7d8d78a5b0b7a57436f194222f0c73310b0b04201c297c8fbf0b00ad6bb3f"
+    },
+    "discovery": "pending",
+    "authenticated": false,
+    "next_action": {
+      "kind": "reload_client",
+      "message": "Start or restart Claude Code in this project, then confirm that it lists the metergraph skill."
+    }
+  },
+  "error": null
+}
+```
+
+- `status` is `installed`, `updated` or `reused` (already in place, nothing rewritten).
+- `path` is always relative to the project. Absolute paths are never printed.
+- On failure `status` and `discovery` are `null`, and `error.reason` is a fixed token
+  such as `not_owned`, `modified`, `update_required`, `not_installed`, `unsafe_path`,
+  `receipt_invalid`, `locked`, `invalid_project`, `client_not_supported`,
+  `write_failed` or `bundled_skill_invalid`.
+
+Without `--json`, results are printed as text on stdout and usage errors go to stderr.
+
+## Safe origins
+
+`--url` accepts only a bare origin, with an optional trailing slash:
+
+- `https://` origins on any host, for example `https://metergraph.example.com`.
+- `http://` only for `localhost`, `127.0.0.1` and `[::1]`, with an optional port.
+
+Usernames, passwords, paths, queries and fragments are rejected before any request is
+made. Invalid values and unknown arguments are not printed back, because a mistyped
+argument can contain a credential. An accepted origin is printed in the output and sent
+to the network, so do not put secrets in a hostname. See [SECURITY.md](SECURITY.md).
+
+## Deployment profiles
+
+The CLI recognizes these `deployment_profile` values: `local`, `managed` and
+`byoc-core`. Managed staging uses the `managed` profile. Any other value is reported as `unsupported` and is not echoed. A server
+without `/v1/deployment`, such as a self-hosted open source server, is reported as
+`unsupported` with `profile_status: "unavailable"` until a dedicated adapter ships. The
+CLI never assumes such a server is hosted.
+
+## What doctor does not do
+
+- It reads no credentials from environment variables, files, arguments or cookies, and
+  sends no `Authorization` or `Cookie` header.
+- It follows no redirects.
+- It reads at most 32 KiB of any response body and stops at the `--timeout-ms` limit.
+- It never prints response bodies, response headers, authentication challenges,
+  server-supplied URLs or error text from the network stack.
+- It makes no model provider calls, sends no usage data and reads no stored traces.
+
+## What skill install does not do
+
+- It makes no network requests and no model provider calls. The skill comes from this
+  package, not from a download.
+- It does not sign in, store credentials, configure MCP or edit client settings.
+- It does not claim a client has loaded the skill. `discovery` stays `pending`.
+- It never prints file contents, absolute paths or raw error text.
+
+## Development
+
+```sh
+npm test                  # unit tests and CLI subprocess tests against loopback servers
+npm run test:package      # npm pack into a temporary directory, clean install, run the installed bin
+node bin/metergraph.js --help
+node bin/metergraph.js doctor --url http://127.0.0.1:8080 --json
+node bin/metergraph.js skill install --client claude --runtime local --project /path/to/project --json
+```
+
+To try a packed artifact without publishing:
+
+```sh
+npm pack --pack-destination "$(mktemp -d)"
+npx --yes --package=/path/to/metergraph-cli-0.1.0.tgz -- metergraph --version
+```
+
+Do not commit tarballs or other generated files.
+
+## Releasing
+
+The source of truth is the public repository
+[github.com/metergraph/cli](https://github.com/metergraph/cli), licensed Apache-2.0.
+The first preview uses the `next` npm tag. Subsequent releases must pass the
+checks below before publication.
+
+Releases are manual. The `Release CLI` workflow (`.github/workflows/release.yml`) runs
+only when a maintainer starts it from `main`. It does not run on tags, pushes or a
+schedule. It:
+
+1. checks that `commit_sha` equals the commit the run started from (see
+   [Exact revision rule](#exact-revision-rule)), that it is on `main`, and that
+   `version` equals `package.json`;
+2. asks the npm registry for that exact version and continues only on a `404`. An
+   existing version, any other status or a network failure stops the run;
+3. runs `npm test` and `npm run test:package` at that commit;
+4. packs the tarball and records its SHA-256;
+5. only if `publish` is true, waits for approval on the `npm-release` environment,
+   checks out the same commit again, verifies the checksum and runs
+   `npm publish --provenance` for that exact tarball.
+
+Leave `publish` false for a dry run that validates and packs without publishing.
+
+### Exact revision rule
+
+npm provenance records the commit that triggered the workflow (`GITHUB_SHA`) as the
+source of the package. To keep that statement true, the workflow only releases that
+commit:
+
+- `commit_sha` must be the full 40 character SHA of the current head of `main`, and it
+  must equal `GITHUB_SHA` for the run. Older commits on `main` are rejected even though
+  they are ancestors of `main`.
+- Both the validate job and the publish job check out that commit and confirm it.
+- If `main` moves after you copy the SHA, the run fails. Start a new run with the new
+  head. To release an older state, land it on `main` first.
+
+### First package bootstrap
+
+npm trusted publishing is configured on a package that already exists, so the very
+first version cannot come from this workflow. Creating the package is a one time,
+human step that a Metergraph maintainer must approve and perform. Nothing in this
+repository automates it, and no npm token or secret is stored here.
+
+1. Confirm the intended npm maintainer accounts and that `metergraph-cli` is
+   available. The first approved publish establishes package ownership.
+2. Run the `Release CLI` workflow with `publish` false. Download the
+   `metergraph-cli-release` artifact and check its SHA-256 against the run summary.
+3. From a maintainer machine with npm two-factor authentication, publish that exact
+   tarball manually using `npm publish /path/to/metergraph-cli-0.1.0.tgz --access public
+   --tag next --provenance=false --ignore-scripts`. This bootstrap version has no
+   provenance attestation. Use a new version for the first trusted release.
+4. Configure trusted publishing as described below.
+
+### Trusted publishing
+
+After the package exists, follow the official npm guide,
+[Trusted publishing for npm packages](https://docs.npmjs.com/trusted-publishers/), and
+add a GitHub Actions trusted publisher with exactly these values:
+
+| Field | Value |
+| --- | --- |
+| Organization or user | `metergraph` |
+| Repository | `cli` |
+| Workflow filename | `release.yml` |
+| Environment name | `npm-release` |
+
+Trusted publishing requires npm 11.5.1 or newer. The publish job checks this before it
+publishes. After the trusted publisher works, consider restricting the package to
+trusted publishing so that long lived tokens cannot publish it.
+
+### Remaining maintainer setup
+
+The source repository and license are settled. Before any automated release, a
+maintainer still has to:
+
+- complete the [first package bootstrap](#first-package-bootstrap);
+- configure the [trusted publisher](#trusted-publishing);
+- create the `npm-release` environment with required reviewers;
+- set the repository variable `METERGRAPH_CLI_PUBLISH_ENABLED` to `true`.
+
+Until all of these are done, leave `publish` false.
+
+### After a release
+
+After each release, confirm from a clean machine, replacing `VERSION`:
+
+```sh
+npx --yes metergraph-cli@VERSION --version --json
+npx --yes metergraph-cli@VERSION doctor --json
+npm view metergraph-cli@VERSION dist.attestations
+```
+
+Releases from the workflow should show a provenance attestation that names
+`metergraph/cli` and the released commit. The bootstrap version will not.
+
+## Security
+
+See [SECURITY.md](SECURITY.md).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).