@mechasm/cli 0.0.0-stage → 0.1.1

package/AGENT_GUIDE.md

@@ -0,0 +1,15 @@
+# Mechasm CLI Agent Guide
+
+Use Node.js 22 or newer. Install `@mechasm/cli`, sign in with `mechasm login`, then check `mechasm doctor`.
+
+Keep each test request in Markdown. Name the project ID, target URL, expected result, and limits. Reuse configured test accounts; do not ask agents to expose credentials or change data outside the named test scope.
+
+```sh
+mechasm tests create --project PROJECT_ID --name "Sign-in" --prompt-file prompt.md --wait --json
+```
+
+Use explicit project, test, and run IDs. Do not assume a default project. Use `--json` for scripts; stdout contains JSON and errors go to stderr. Save run IDs and log cursors in workflow state. Resume logs with `--after CURSOR` after reconnecting.
+
+Exit code `5` means the run failed or was stopped. Code `2` means invalid arguments, `3` authentication failed, and `4` permission was denied. The optional npm update notice runs only in interactive non-JSON sessions; CI skips it.
+
+See [CLI documentation](https://mechasm.ai/docs/mechasm-cli/getting-started) for full command details.

package/LICENSE

@@ -0,0 +1,11 @@
+Proprietary License
+
+Copyright (c) Mechasm. All rights reserved.
+
+This license permits use of the CLI to access Mechasm services, subject to
+the terms applicable to those services. No permission is granted to copy,
+modify, distribute, publish, or sublicense the CLI without prior written
+authorization from Mechasm.
+
+The software is provided "as is", without warranty of any kind, express or
+implied, to the maximum extent permitted by applicable law.

package/README.md

@@ -1,3 +1,108 @@
-# Temporary Holding Version
+# Mechasm 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.
+Manage Mechasm projects, tests, runs, and local apps from a terminal or CI workflow.
+
+## Install
+
+Use Node.js 22 or newer. Install the CLI globally:
+
+```sh
+npm install -g @mechasm/cli
+```
+
+Check the installation and sign in:
+
+```sh
+mechasm --version
+mechasm login
+mechasm doctor
+mechasm whoami
+```
+
+`doctor` checks the CLI version, API connection, sign-in, and local service state. Sign in before running it; a stopped local service is informational unless you use local-app runs.
+
+## Sign in and choose access
+
+```sh
+mechasm login
+mechasm whoami
+mechasm projects list
+```
+
+Approve the existing projects and actions this device needs. Project access and permission to create projects in a team are separate. Team project-creation access does not grant access to existing projects in that team. If a project or team is missing, sign in again and approve access; your account must already have access to it.
+
+Pass project IDs explicitly to test, run, variable, and local-app commands. The CLI does not select a default project.
+
+## Create a project and run a test
+
+```sh
+mechasm teams list
+mechasm projects create --name "Store QA" --url https://app.example.com --team TEAM_ID
+mechasm tests create --project PROJECT_ID --name "Home page" --prompt "Open the home page and check that it loads." --wait --json
+```
+
+Replace `TEAM_ID`, `PROJECT_ID`, and the example URL with your values. `--team` is optional when exactly one team is approved. The project creation response contains the project ID to use in later commands.
+
+Commands that start a run return its `runId` and workspace `runUrl`. `--wait` waits for the final result. Failed or stopped runs exit with code 5.
+
+## Manage variables safely
+
+Supply variable values through a file or standard input. Do not put values in command arguments. Choose one method for each variable:
+
+```sh
+mechasm variables set API_KEY --project PROJECT_ID --value-file ./api-key.txt
+printf %s "$API_KEY_VALUE" | mechasm variables set API_KEY --project PROJECT_ID --value-stdin
+```
+
+Use the same commands to list or remove a variable:
+
+```sh
+mechasm variables list --project PROJECT_ID
+mechasm variables unset OLD_KEY --project PROJECT_ID
+```
+
+Each value can be up to 64 KiB. Keys must be 1–255 characters, uppercase, and contain no whitespace. Existing IMAP and VPN integration settings are supported. Command output shows variable names, not their values. `--value-stdin` cannot be combined with `--token-stdin`; use a value file when supplying a token through standard input.
+
+## Use a local app
+
+The CLI service stays connected and ready between runs. During a run, Mechasm connects to the selected app on your device; that connection closes when the run work ends.
+
+```sh
+mechasm service start
+mechasm local register --project PROJECT_ID --url http://localhost:3000 --ports 3000,8080
+mechasm local list --project PROJECT_ID
+```
+
+Replace the example ports with the ones your app needs. Include the URL's port. You can approve up to 16 ports per project. Multiple runs against the same local app share its application state and data, so isolate test data if concurrent runs could interfere.
+
+## Command groups
+
+- Account: `login`, `logout`, `whoami`
+- Teams and projects: `teams list`, `projects list`, `projects create`
+- Variables: `variables list`, `variables set`, `variables unset`
+- Tests: `tests create`, `tests edit`, `tests list`, `tests get`, `tests run`
+- Runs: `runs status`, `runs get`, `runs wait`, `runs logs`, `runs stop`, `runs video`, `runs trace`, `runs variables`
+- Local apps: `local register`, `local list`, `local select`, `local ports set`, `local unregister`
+- Service: `service start`, `service stop`, `service status`, `service foreground`
+- Updates: `update`
+
+Run `mechasm --help` for command syntax. Use `--json` for scripts: JSON goes to stdout and errors go to stderr. Failed or stopped runs exit with code `5`; invalid arguments use `2`, authentication failures `3`, and denied permissions `4`. See the [CLI guides](https://mechasm.ai/docs/mechasm-cli/getting-started) for task-by-task instructions:
+
+- [Authentication & Permissions](https://mechasm.ai/docs/mechasm-cli/authentication-permissions)
+- [Teams & Projects](https://mechasm.ai/docs/mechasm-cli/teams-projects)
+- [Tests](https://mechasm.ai/docs/mechasm-cli/tests)
+- [Runs, Logs & Artifacts](https://mechasm.ai/docs/mechasm-cli/runs-logs-artifacts)
+- [Local Apps & Devices](https://mechasm.ai/docs/mechasm-cli/local-apps-devices)
+- [Command Reference & Troubleshooting](https://mechasm.ai/docs/mechasm-cli/command-reference)
+- [Agent Workflows](https://mechasm.ai/docs/mechasm-cli/agent-workflows)
+
+In an interactive terminal, the CLI checks npm at most once per day and prints an upgrade command when a newer version is available. It skips JSON output, CI, and the long-running foreground service. Set `MECHASM_NO_UPDATE_NOTIFIER=1` to disable the notice. `mechasm update` prints `npm install -g @mechasm/cli@latest`.
+
+Before upgrading, let local runs finish. If the CLI service is running, restart it after installation so it uses the new version:
+
+```sh
+mechasm service stop
+mechasm service start
+```
+
+Pass the same `--api-url` to both commands if you use a custom API origin.

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,11 @@
+# Third-party notices
+
+## frp
+
+The CLI downloads frp 0.71.0 binaries at runtime from the official frp GitHub
+releases and verifies each archive against a pinned SHA-256 checksum. frp is
+licensed under the Apache License, Version 2.0. A copy of the applicable
+upstream `LICENSE` is included at `licenses/frp-LICENSE`. The upstream
+v0.71.0 repository has no top-level `NOTICE` file. Source: <https://github.com/fatedier/frp/tree/v0.71.0>.
+
+The npm package does not include frp source or binaries.

package/bin/mechasm.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { runCli } from '../src/cli.js';
+
+await runCli();

package/licenses/frp-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/package.json

@@ -1,6 +1,44 @@
 {
   "name": "@mechasm/cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "Mechasm command line client",
+  "license": "SEE LICENSE IN LICENSE",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "bin": {
+    "mechasm": "bin/mechasm.js"
+  },
+  "files": [
+    "bin/mechasm.js",
+    "src/api-client.js",
+    "src/cli.js",
+    "src/diagnostics.js",
+    "src/notifier.js",
+    "src/service.js",
+    "src/version.js",
+    "src/frp.js",
+    "src/local-approvals.js",
+    "src/update-guard.js",
+    "AGENT_GUIDE.md",
+    "README.md",
+    "LICENSE",
+    "THIRD_PARTY_NOTICES.md",
+    "licenses/frp-LICENSE"
+  ],
+  "scripts": {
+    "test": "node --test",
+    "release:check": "node scripts/verify-npm-package.mjs"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "bugs": {
+    "email": "support@mechasm.ai"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/scstan/mechasm-cli.git"
+  }
+}