esp-morpheus 0.9.0__tar.gz

esp_morpheus-0.9.0/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.

esp_morpheus-0.9.0/PKG-INFO

@@ -0,0 +1,434 @@
+Metadata-Version: 2.4
+Name: esp-morpheus
+Version: 0.9.0
+Summary: Console client for an ESP RainMaker Neo deployment
+Author: Espressif Systems (Shanghai) CO LTD
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/espressif/esp-rainmaker-neo
+Project-URL: Source, https://github.com/espressif/esp-rainmaker-neo
+Project-URL: Changelog, https://github.com/espressif/esp-rainmaker-neo/blob/main/cli/CHANGELOG.md
+Keywords: espressif,rainmaker,iot,matter,cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: boto3>=1.43
+Requires-Dist: botocore>=1.43
+Requires-Dist: requests>=2.32
+Requires-Dist: cryptography>=44
+Requires-Dist: PyJWT>=2.9
+Requires-Dist: awscrt>=0.36
+Requires-Dist: awsiotsdk>=1.31
+Requires-Dist: prompt_toolkit>=3.0.50
+Requires-Dist: click>=8.1
+Requires-Dist: rich>=13.7
+Requires-Dist: bleak>=3.0
+Requires-Dist: protobuf<7,>=6.30
+Requires-Dist: ask-smapi-sdk>=1.0
+Requires-Dist: ask-smapi-model>=1.36
+Requires-Dist: ask-sdk-model-runtime>=1.0
+Provides-Extra: camera
+Requires-Dist: aiortc>=1.15; extra == "camera"
+Requires-Dist: websockets>=11.0; extra == "camera"
+Requires-Dist: opencv-python>=4.8; extra == "camera"
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == "test"
+Dynamic: license-file
+
+# `esp-morpheus` — the ESP RainMaker Neo console client
+
+`esp-morpheus` configures and exercises an ESP RainMaker Neo deployment end to end. It authenticates
+users, registers and destroys IoT nodes, drives the user-facing REST API, connects to MQTT as a user
+or as a simulated device, and manages groups, sharing, mobile push platforms and Matter
+commissioning. It validates any deployment feature with no device and no phone app.
+
+It installs as a command and runs from any directory, against any deployment, with no checkout of
+this repository.
+
+To reach a deployment, `esp-morpheus` needs its **outputs**: every deployment publishes its common
+outputs to one file, which phone apps, the dashboard and this client all read. `esp-morpheus` reads
+`rmng-outputs.json`, or the source given by `--client-outputs`.
+
+Most of `esp-morpheus` needs nothing else. Driving a deployment as a user or a node goes through the
+deployment's own API and its MQTT broker — an end user signs in against the API and is handed
+credentials by it — so `esp-morpheus --client-outputs <url> user someone@example.com` works with no AWS
+account, no profile, and no checkout.
+
+**AWS credentials** are needed only under `esp-morpheus admin`, which holds the whole privileged
+surface: every command that reaches AWS directly or calls the admin API. The ones that reach AWS
+create, delete or sweep real resources, so they check that the credentials name the account in the
+outputs and refuse to run against another one. The region is not enforced: every AWS client is
+built with the region from the outputs, so a differing ambient region is reported and ignored.
+
+---
+
+## 1. Install
+
+```bash
+pip install esp-morpheus
+```
+
+`user <id> node camera-stream` needs the WebRTC stack (aiortc, OpenCV), which is heavy and ships as
+an extra:
+
+```bash
+pip install 'esp-morpheus[camera]'
+```
+
+From a checkout, install it in place:
+
+```bash
+pip install -e ./cli
+```
+
+Needs Python 3.12 or later.
+
+## 2. Point it at a deployment
+
+The outputs are a JSON file keyed by stack name (`espuser-base`, `espuser-core`, `rmng-base`,
+`rmng-core`, ...). Give `esp-morpheus` a path or a URL.
+
+**A local file (default).** With no flag, `esp-morpheus` reads `rmng-outputs.json`. Run from
+anywhere inside a checkout, a relative path resolves against the repo root (`MORPHEUS_REPO_ROOT`
+overrides the detected root); run from outside one, it resolves against the working directory.
+
+```bash
+esp-morpheus user someone@example.com
+```
+
+**A URL.** Point `--client-outputs` at a published outputs file, such as the per-region
+client-outputs in S3. It is fetched at startup, so nothing is downloaded by hand. The bucket is
+always in `us-east-1`; the path names the deployment's region.
+
+```bash
+esp-morpheus --client-outputs https://rmng-public-assets-123456789012.s3.us-east-1.amazonaws.com/ap-south-1/rmng-client-outputs.json \
+             user someone@example.com
+```
+
+`MORPHEUS_OUTPUTS` sets the same value, so a shell session can pick a deployment once.
+
+## 3. Pick an identity
+
+Everything `esp-morpheus` does, it does as somebody.
+
+### An account that already exists
+
+Pass any account provisioned in the deployment.
+
+```bash
+esp-morpheus user someone@example.com            # prompts for the password
+```
+
+This tree is the end-user API and nothing else: it signs in against the end-user pool, and an admin
+account belongs to `esp-morpheus admin`. `--password` belongs to `user`, so it comes before the
+identity; everything after it is the subcommand.
+
+The password is read from `--password`, then `RMNG_PASSWORD`, then a prompt. Prefer the prompt or
+the environment variable: a password in `--password` is visible to other processes and lands in
+shell history.
+
+`esp-morpheus` signs in before running anything, so a wrong password is reported at the prompt rather
+than by whichever command you run first. A typed one can be retyped, up to three tries; one from
+`--password` or `RMNG_PASSWORD` fails straight away with exit code 3, since a script cannot answer
+a prompt. `auth` is the exception — it provisions an account that may not exist yet, so it runs
+even when sign-in fails, and the interactive prompt opens on a warning for the same reason.
+
+### Or seed test users and devices
+
+For quick validation against a scratch deployment, `admin test-data setup` creates a known set of
+users and nodes from `test_config.json`. It registers every user and node, creates a default `Home`
+group per user, and associates nodes flagged with `associate_to`.
+
+```bash
+esp-morpheus admin test-data setup
+```
+
+On a fresh install this also writes `test_config.json` from the packaged defaults, generating
+passwords and device certificates. It holds secrets: never commit or share it. The seeded admin is
+marked `"admin": true`, which is how `esp-morpheus admin` finds it without naming one. `node_multi`
+and `node_switch` are associated with `test-user1@example.com`.
+
+It needs AWS credentials for the deployment's account (Cognito for the admin, IoT for node
+certificates), from any source boto3 reads. The region comes from the outputs.
+
+```bash
+export AWS_PROFILE=<profile>        # or AWS_ACCESS_KEY_ID + AWS_SECRET_ACCESS_KEY
+```
+
+"AWS account mismatch" means the credentials are for another account than the outputs name. A
+re-run reuses existing users, groups and certificates; "Node ... was not registered" means the node
+already exists.
+
+The file is `cli/test_config.json` inside a checkout and `~/.config/morpheus/test_config.json`
+elsewhere. Run from the other place, `setup` writes a new one with fresh passwords and certificates;
+`MORPHEUS_CONFIG` pins one path.
+
+```bash
+esp-morpheus user someone@example.com
+esp-morpheus device node_rsa
+```
+
+`admin test-data destroy` removes them again: the seeded devices, their groups, and any leftover
+`test-*` certificates. It deletes only test-created things and leaves the rest of the deployment
+alone; `--dry-run` lists what it would delete.
+
+### Or create the CI bot user
+
+`admin bot-user create` creates an IAM user with AdministratorAccess for CI, and writes its access
+keys to `bot-iam-user-credentials.json` next to `test_config.json`. The name defaults to `bot`. Pass
+another one, and `esp-morpheus` saves it as `ci_bot_user` in `test_config.json`, so `delete` and `show`
+find it again.
+
+```bash
+esp-morpheus admin bot-user create      # or: esp-morpheus admin bot-user create rmng-ci
+esp-morpheus admin bot-user show
+esp-morpheus admin bot-user delete
+```
+
+One bot at a time. There is a single credentials file, so a second user under another name would
+overwrite the keys of the first and leave it in IAM with a live admin key nothing tracks. `create`
+refuses a new name until `delete` removes the current bot. A name IAM no longer has is stale, and
+does not block a create.
+
+A second `create` under the same name fails rather than invalidate the key CI is using. Use
+`create --rotate` to replace the keys of an existing user, which is the way back when the
+credentials file is lost.
+
+## 4. One command, or a prompt
+
+Every command runs two ways. Name it on the command line and `esp-morpheus` runs it and exits:
+
+```bash
+esp-morpheus user someone@example.com group list
+```
+
+Name no subcommand and `esp-morpheus` opens a prompt bound to that identity, where the
+`esp-morpheus user someone@example.com` prefix is implicit:
+
+```
+$ esp-morpheus user someone@example.com
+User context: someone@example.com
+Type help for commands, q to leave.
+someone@example.com > group create My Home
+someone@example.com > api get v1/user/nodes
+someone@example.com > q
+```
+
+Tab completes the command tree. `help` lists the commands and `help <command>` prints its full help,
+both generated from the same tree the dispatcher uses, so neither can drift. A bad command, a failed
+call and `Ctrl-C` all return you to the prompt; `q`, `quit` and `Ctrl-D` leave.
+
+## 5. The command tree
+
+```
+esp-morpheus [--client-outputs SRC] [--json] [--raw] [-v]
+  user [--password PW] <identity> [SUBCOMMAND...]             # no subcommand -> prompt
+      auth  connect  subscribe  publish  read-shadow  upload-file
+      api                    get | post | put | patch | delete
+      group                  create | list | rename | add-capabilities | share
+      group subgroup         create | rename | add-node | remove-node | share
+      node                   assoc | remove | claim
+      matter                 initiate | verify | confirm | get-noc
+      sharing                list | accept | reject
+      push                   register-ios | register-android | register
+  device <node> [SUBCOMMAND...]                               # no subcommand -> prompt
+      connect  shadow-connect  subscribe  publish  to-cloud  group-info
+      set-node-config  direct-notify
+  admin [IDENTITY] [--password PW] [SUBCOMMAND...]            # no subcommand -> prompt
+      integrations           alexa | gva | smartthings
+      platforms              register-ios | register-android | list
+                             update-ios | update-android | delete
+      nodes                  register | bulk-register | bulk-status
+      iot-event-mode         get | set
+      claiming               enable
+      ses                    setup-sender | request-production
+      sns                    request-production
+      test-data              setup | destroy
+                             gen-device <name> <rsa|ec> [--stdout] [--force]
+      bot-user               create [NAME] [--rotate] | delete [NAME] | show
+      guide                  alexa | gva | smartthings | ios | android
+  app-sim [--password PW] <identity>
+      list  select  stats  update  update-group  update-subgroup  prov
+      schedule               set | get | delete
+      automation             create | add-trigger | add-action | complete
+                             list | get | delete
+  device-sim <node>
+      update-params  update-tags
+```
+
+There are **two layers**. `user` and `device` are the raw operations: one user-side or device-side
+call at a time. `app-sim` and `device-sim` sit on top and run the sequence of raw operations a real
+phone app or a real node performs.
+
+`admin` is the third tree, and the only privileged one: everything that needs AWS credentials or the
+admin API is under it, so what the rest of `esp-morpheus` reaches is what an ordinary account reaches.
+`guide` and `test-data gen-device` are the exceptions in the other direction — they need neither,
+and sit there because each one's other half is an admin command: `guide` prints the console side of
+a setup, and the node `gen-device` writes is inert until `test-data setup` registers it.
+
+### `user` — the user API and a user's MQTT session
+
+```
+auth                                       # authenticate and register the user
+group list                                 # groups, with their nodes and subgroup ids
+group create My Home                       # create a group
+group create --matter My Home              # create it as a Matter fabric
+node assoc node_rsa <group_id>             # associate a device into a group
+node camera-stream <node_id> --stats-only  # view a camera's live video over KVS WebRTC
+api get v1/user/nodes                      # raw GET against the user API
+connect                                    # assume role, then connect to MQTT
+subscribe node_rsa params local            # subscribe to a node's named shadows
+push register-ios com.app.id <token>       # register a push endpoint
+sharing list                               # pending shares
+```
+
+### `admin` — deployment-wide operations
+
+One tree for everything privileged, so what the rest of `esp-morpheus` can reach is what an ordinary
+account can reach.
+
+Its commands split in two. `integrations`, `platforms`, `nodes`, `iot-event-mode` and `claiming`
+call the admin API, which returns 403 for a regular user, so they need an admin identity: name one
+before the command, and without it `esp-morpheus` uses the admin `test_config.json` flags. `ses`, `sns`,
+`test-data` and `bot-user` call AWS directly and need no identity at all — only credentials for the
+account the outputs name.
+
+```bash
+esp-morpheus admin platforms list
+esp-morpheus admin admin@example.com platforms list
+esp-morpheus admin                             # a prompt over the same tree
+```
+
+```
+platforms register-ios key.p8 <key_id> <team_id> <bundle_id> --sandbox
+platforms register-android service-account.json
+integrations alexa setup-auto
+integrations smartthings setup st-config.json
+nodes bulk-register nodes.csv --tags created_by:ci
+iot-event-mode set sqs
+claiming enable
+ses setup-sender otp@company.com           # SES mails a link; the owner opens it
+ses setup-sender --mailosaur               # mint a test address and open the link for you
+test-data setup
+bot-user create
+```
+
+### `device` — a physical node
+
+Acts as a node using the certificate and key from `nodes[]`, over MQTT/TLS.
+
+```
+connect                                    # connect and subscribe to from_cloud
+group-info                                 # the node's group and subgroup ids
+publish params {"Light":{"power":true}}    # update a named shadow
+to-cloud {"temp":25}                       # publish to the node-to-cloud topic
+direct-notify --file notification.json
+set-node-config node_config.json
+```
+
+### `device-sim <thing_name>` — the device simulator
+
+A node that reports params and tags. Unlike `app-sim`, this one does need a `test_config.json`
+entry: a node authenticates with a certificate and key, which cannot be typed at a prompt. The
+entry also needs `node_cfg` and `node_tags`; only `node_multi` and `node_switch` qualify in the
+default config.
+
+```
+update-params {"Colour Light":{"Power":true}}
+update-tags {"location":"hall"}
+```
+
+It connects with the node's certificate and needs no AWS credentials. To control it from the phone
+app, sign in as the node's `associate_to` user (`test-user1@example.com` for `node_multi`); the
+password is in `test_config.json`. The simulator has no BLE, so there is no QR to scan: `test-data
+setup` already associated it. To use your own account, share the group and accept in the app:
+
+```bash
+esp-morpheus user test-user1@example.com group list
+esp-morpheus user test-user1@example.com group share <group_id> primary --username <your-email>
+```
+
+App changes print in the device-sim terminal; `update-params` sends changes back.
+
+### `app-sim <identity>` — the app simulator
+
+The mobile app for a user: groups, automations, schedules and BLE provisioning. It resolves and
+checks IDENTITY exactly as `esp-morpheus user` does, prompting for a password, so it drives any account
+in the deployment rather than only the ones in `test_config.json`.
+
+```
+list                                       # the user's groups
+select <group_id>                          # choose the active home
+update <node_id> {"Light":{"power":true}}
+automation create Evening lights
+schedule get <node_id>
+prov                                       # BLE provisioning
+```
+
+## 6. Output
+
+By default a command prints a curated view of its result. Two flags change that:
+
+| Flag | Effect |
+| --------- | ------------------------------------------------------------------------ |
+| `--raw` | Print each payload as JSON, to see what the API returned rather than the fields the command chose to show. |
+| `--json` | The same JSON, plus stdout reserved for it — every message goes to stderr. |
+| `-v` | Add the API request trace, printed verbatim. |
+
+The request trace is off unless you ask for it, and prints bodies verbatim so a token can be
+decoded and its claims checked. That means it shows real credentials — `POST /v1/user/credentials`
+answers with a live secret key and session token — so redirect it rather than pasting it around.
+
+## 7. Scripting
+
+`--json` puts the payload on stdout and every other word on stderr, so a command pipes straight into
+`jq`:
+
+```bash
+esp-morpheus --json user someone@example.com api get v1/user/nodes | jq -e '.nodes'
+```
+
+Exit codes say what happened, so a script can branch without parsing text:
+
+| Code | Meaning |
+| ---- | ------------------------------------------------ |
+| 0 | Success |
+| 1 | The command ran and failed |
+| 2 | Usage error: an unknown command or a bad argument |
+| 3 | Authentication or authorisation failed |
+
+## 8. Where state lives
+
+Inside a checkout, `esp-morpheus` keeps using the paths that are already there: `cli/test_config.json`,
+`cli/.*.command_history` and `.sim/`. Installed, it uses XDG directories and writes nothing to the
+working directory.
+
+| What | In a checkout | Installed |
+| ------------------- | -------------------------- | --------------------------------- |
+| `test_config.json` | `cli/` | `~/.config/morpheus/` |
+| Command history | `cli/.<context>.command_history` | `~/.cache/morpheus/` |
+| Simulator caches | `.sim/<name>/` | `~/.cache/morpheus/sim/<name>/` |
+| Vendored `esp_prov` | `.vendor/` | `~/.cache/morpheus/vendor/` |
+
+`MORPHEUS_CONFIG` overrides the config file, `MORPHEUS_CONFIG_DIR` and `MORPHEUS_CACHE_DIR` the
+directories.
+
+## 9. The Python SDK
+
+The same distribution ships the SDK the CLI is built on, so a test or a script can drive a
+deployment directly:
+
+```python
+from esp_morpheus.sdk.user import User
+from esp_morpheus.outputs import RmngSettings
+```
+
+From a clone of this repo, `py_sdk.test_user` and the other pre-rename paths keep working and
+name the same modules; they need no install, because `py_sdk/__init__.py` finds `cli/src` itself.