multicloud-cli 0.1.0__tar.gz

multicloud_cli-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+# Build output of the multicloud-cli package. Hatch puts this file, not the repository one, into the sdist.
+dist/
+__pycache__/
+.venv/
+.pytest_cache/

multicloud_cli-0.1.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.
+

multicloud_cli-0.1.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.5
+Name: multicloud-cli
+Version: 0.1.0
+Summary: mctl: sign in to Multicloud and connect your cloud account
+Author-email: Multicloud Team <info@multicloud.io>
+License: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1
+Requires-Dist: keyring>=24
+Requires-Dist: requests>=2.31
+Provides-Extra: test
+Requires-Dist: pytest>=8; extra == 'test'
+Description-Content-Type: text/markdown
+
+# multicloud-cli
+
+`mctl` connects your AWS account to [Multicloud](https://multicloud.io).
+Multicloud then starts machines in your account, and AWS bills you directly.
+You give Multicloud no password and no access key: you create one IAM role with the public
+Terraform module [multicloud/multicloud/aws](https://registry.terraform.io/modules/multicloud/multicloud/aws).
+
+The package is not on PyPI yet, so these commands do not work today. When it is published, install it with:
+
+```bash
+pipx install multicloud-cli        # or: uv tool install multicloud-cli
+```
+
+If `mctl` is not found after the install, run `uv tool update-shell` (or `pipx ensurepath`) and open a new shell.
+
+## Connect an AWS account
+
+You need to be an owner of your team on multicloud.io, an AWS login that can create IAM roles, and
+OpenTofu or Terraform 1.5 or later.
+
+```bash
+mctl auth login                       # opens your browser; sign in as you do on multicloud.io
+mkdir multicloud-aws && cd multicloud-aws
+mctl cloud-account create --cloud AWS --account 123456789012 --region us-east-1
+mctl cloud-account apply 7            # init, plan, asks you, apply, then waits for "Ready"
+```
+
+Keep the folder: it holds the Terraform state of the role.
+
+To run OpenTofu or Terraform yourself, get a one-time connect code instead of `apply`:
+
+```bash
+mctl cloud-account token 7            # prints one "export TF_VAR_multicloud_connect_token=..." line
+tofu init && tofu apply
+mctl cloud-account verify 7 --wait
+```
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `mctl auth login` | Sign in with your browser (SSO). `--no-browser` prints a code to enter on another device (SSH, containers). `--api-key` stores an API key instead (hidden prompt or `--key-stdin`). |
+| `mctl auth status` / `logout` | Show how you are signed in and check it works; end the session and remove the stored sign-in and key. |
+| `mctl cloud-account create` | Declare an AWS account and write `multicloud.tf`. |
+| `mctl cloud-account apply <id>` | `init`, `plan`, a question (`--yes` skips it, `--plan-only` stops after the plan), then `apply` with a fresh connect code and a wait for the check. |
+| `mctl cloud-account token <id>` | A new one-time connect code, for a manual `terraform apply`. |
+| `mctl cloud-account verify <id> [--wait]` | Check the role again: `Ready` (exit 0), the missing permissions (exit 1) or pending (exit 5). |
+| `mctl cloud-account list` / `show <id> [--json]` | The connections of your team. |
+
+The connect code reaches Terraform only through the environment of the `apply` process.
+`mctl` never prints a key or a token, and only `mctl cloud-account token` prints a connect code.
+
+## Sign in
+
+`mctl auth login` opens your browser on `auth.multicloud.io` (authorization code with PKCE, on a temporary
+port of `127.0.0.1`). `mctl auth login --no-browser` uses the device flow instead: it prints a web address and a
+code, and you sign in on any device. Both give a short-lived access token (15 minutes) and a refresh token.
+`mctl` keeps them in the OS key store, else in `~/.config/multicloud/credentials` (mode 0600), and refreshes the
+access token by itself. A session ends after at most 10 hours; then run `mctl auth login` again.
+
+- **Organization.** The sign-in holds the organizations you belong to. With one, no `--org` is needed. With
+  several, name one: `--org <team-id>` or `MULTICLOUD_ORG`.
+- **Order of credentials.** `MULTICLOUD_API_KEY` (for CI), then the SSO sign-in, then a stored API key.
+- **Roles.** Pool reads need membership. Everything that changes a pool, and every `cloud-account` command, needs the
+  owner role of the team (an API key with the matching scope works too).
+- **Logout.** `mctl auth logout` ends the session at Keycloak and deletes the local copy. Because `mctl` shares
+  your Keycloak browser session, it signs you out of Keycloak in your browser too.
+- **Settings.** `MULTICLOUD_ISSUER_URL` (or `issuer` in `~/.config/multicloud/cli.json`) overrides the Keycloak
+  realm URL `https://auth.multicloud.io/realms/multicloud`. Like the API URL it must be `https://`.
+- **Other environments.** The defaults point to production (`auth.multicloud.io`, `api.multicloud.io`). For
+  another environment, set `MULTICLOUD_ISSUER_URL` (for example `https://auth.example.com/realms/multicloud`) and
+  `MULTICLOUD_API_URL` (for example `https://api.example.com`) to that environment's hosts before `mctl auth login`. Set both: the sign-in server (issuer) and the API must belong
+  to the same environment, or the API rejects the token.
+- **API key (CI, scripts).** `mctl auth login --api-key --org <team-id>`, or `MULTICLOUD_API_KEY` in the environment.
+
+## Manage CI pools
+
+A pool is a group of build machines that Multicloud starts for you and stops when they are idle.
+With an API key, reading needs **Read** access, create and update need **Write**, and delete, hibernate and wake need **Admin**.
+With an SSO sign-in, reading needs team membership and the rest needs the owner role.
+Every command takes `--org <team-id>` (also before the command: `mctl --org acme pool list`) and, where it makes
+sense, `--json` for the raw answer. `pool list` and `cloud-account list` take `-q` (only the IDs) and
+`--no-headers`. Data goes to stdout; progress and questions go to stderr.
+`<pool>` is the number from `mctl pool list` or the exact pool name.
+
+```bash
+mctl pool classes                                  # the machine sizes you can ask for
+mctl pool create ci --github-org my-gh-org --max-cost-per-hour 2 --classes cpu-4 \
+  --clouds '[{"type":"AWS","regions":["us-east-1"]}]'
+mctl pool list
+mctl pool hibernate ci                             # pause: no machines, no cost, the name stays
+mctl pool wake ci --wait --timeout 15m             # exit 0 ready, 5 timeout, 6 pool deleted, 1 other error
+```
+
+| Command | What it does |
+|---|---|
+| `mctl pool create <name>` | Make a pool. Use `--from-file pool.json` for the full request, or the flags `--github-org`, `--clouds`, `--classes`, `--max-cost-per-hour`, `--spot-policy`, `--cpu-units-requests`, `--image-by-class`, `--egress-by-class`, `--class-headroom`. A repeated run with the same `--idempotency-key` makes one pool. Put cloud keys in the file, not on the command line. |
+| `mctl pool update <pool>` | Change `--max-cost-per-hour`, `--classes`, `--spot-policy`, `--cpu-units-requests` or `--clouds`. Only the options you give change. |
+| `mctl pool show <pool>` / `cluster <pool>` | The pool, or its machines and their cost. |
+| `mctl pool hibernate <pool>` / `wake <pool>` | Pause or resume a pool. |
+| `mctl pool delete <pool> [-y]` | Delete a pool for good. It asks first; without a terminal, `-y` is required. To pause a pool, use `hibernate`. |
+| `mctl pool rotate-credentials <pool>` / `rotation-status <pool>` | Renew the pool's access credentials; show the progress of the last renewal. |
+
+## Find servers and prices
+
+The catalog lists the servers of AWS, Azure and Google Cloud with prices. An API key needs the **Catalog** access
+(`catalog` scope); `MULTICLOUD_API_KEY` needs no `--org`. Filter names are the API names: `--min-vcpus` and
+`--min_vcpus` both work. Data goes to stdout; the page line (`Page 1 of 3, 42 results.`) goes to stderr.
+
+```bash
+mctl catalog search --provider aws --min-vcpus 8 --max-price-per-hour 0.5 --sort-by vcpus
+mctl catalog search --has-accelerator --accelerator-name 'A100.*' --price-type SPOT -q   # only the IDs
+mctl catalog show 11
+mctl catalog compare 11 12 13
+mctl catalog locations --provider aws
+mctl catalog providers
+mctl catalog field-values                          # the values the filters accept
+```
+
+Every command takes `--json`. See [docs/reference.md](docs/reference.md) for all options.
+
+## Use it from an AI agent
+
+The skill `multicloud-connect-aws` in [multicloud/skills](https://github.com/multicloud/skills) teaches an agent
+such as Claude Code to run these commands. The agent asks you before each apply and never sees the key or the code.
+
+## More
+
+Every command shows its options with `--help` or `-h`, for example `mctl pool create -h`.
+The exit codes, shell completion and all options are in the [command reference](docs/reference.md):
+0 ok, 1 error, 2 usage, 3 sign-in or access, 4 not found, 5 still pending or wait timeout, 6 pool gone.
+
+License: Apache-2.0.

multicloud_cli-0.1.0/README.md

@@ -0,0 +1,133 @@
+# multicloud-cli
+
+`mctl` connects your AWS account to [Multicloud](https://multicloud.io).
+Multicloud then starts machines in your account, and AWS bills you directly.
+You give Multicloud no password and no access key: you create one IAM role with the public
+Terraform module [multicloud/multicloud/aws](https://registry.terraform.io/modules/multicloud/multicloud/aws).
+
+The package is not on PyPI yet, so these commands do not work today. When it is published, install it with:
+
+```bash
+pipx install multicloud-cli        # or: uv tool install multicloud-cli
+```
+
+If `mctl` is not found after the install, run `uv tool update-shell` (or `pipx ensurepath`) and open a new shell.
+
+## Connect an AWS account
+
+You need to be an owner of your team on multicloud.io, an AWS login that can create IAM roles, and
+OpenTofu or Terraform 1.5 or later.
+
+```bash
+mctl auth login                       # opens your browser; sign in as you do on multicloud.io
+mkdir multicloud-aws && cd multicloud-aws
+mctl cloud-account create --cloud AWS --account 123456789012 --region us-east-1
+mctl cloud-account apply 7            # init, plan, asks you, apply, then waits for "Ready"
+```
+
+Keep the folder: it holds the Terraform state of the role.
+
+To run OpenTofu or Terraform yourself, get a one-time connect code instead of `apply`:
+
+```bash
+mctl cloud-account token 7            # prints one "export TF_VAR_multicloud_connect_token=..." line
+tofu init && tofu apply
+mctl cloud-account verify 7 --wait
+```
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `mctl auth login` | Sign in with your browser (SSO). `--no-browser` prints a code to enter on another device (SSH, containers). `--api-key` stores an API key instead (hidden prompt or `--key-stdin`). |
+| `mctl auth status` / `logout` | Show how you are signed in and check it works; end the session and remove the stored sign-in and key. |
+| `mctl cloud-account create` | Declare an AWS account and write `multicloud.tf`. |
+| `mctl cloud-account apply <id>` | `init`, `plan`, a question (`--yes` skips it, `--plan-only` stops after the plan), then `apply` with a fresh connect code and a wait for the check. |
+| `mctl cloud-account token <id>` | A new one-time connect code, for a manual `terraform apply`. |
+| `mctl cloud-account verify <id> [--wait]` | Check the role again: `Ready` (exit 0), the missing permissions (exit 1) or pending (exit 5). |
+| `mctl cloud-account list` / `show <id> [--json]` | The connections of your team. |
+
+The connect code reaches Terraform only through the environment of the `apply` process.
+`mctl` never prints a key or a token, and only `mctl cloud-account token` prints a connect code.
+
+## Sign in
+
+`mctl auth login` opens your browser on `auth.multicloud.io` (authorization code with PKCE, on a temporary
+port of `127.0.0.1`). `mctl auth login --no-browser` uses the device flow instead: it prints a web address and a
+code, and you sign in on any device. Both give a short-lived access token (15 minutes) and a refresh token.
+`mctl` keeps them in the OS key store, else in `~/.config/multicloud/credentials` (mode 0600), and refreshes the
+access token by itself. A session ends after at most 10 hours; then run `mctl auth login` again.
+
+- **Organization.** The sign-in holds the organizations you belong to. With one, no `--org` is needed. With
+  several, name one: `--org <team-id>` or `MULTICLOUD_ORG`.
+- **Order of credentials.** `MULTICLOUD_API_KEY` (for CI), then the SSO sign-in, then a stored API key.
+- **Roles.** Pool reads need membership. Everything that changes a pool, and every `cloud-account` command, needs the
+  owner role of the team (an API key with the matching scope works too).
+- **Logout.** `mctl auth logout` ends the session at Keycloak and deletes the local copy. Because `mctl` shares
+  your Keycloak browser session, it signs you out of Keycloak in your browser too.
+- **Settings.** `MULTICLOUD_ISSUER_URL` (or `issuer` in `~/.config/multicloud/cli.json`) overrides the Keycloak
+  realm URL `https://auth.multicloud.io/realms/multicloud`. Like the API URL it must be `https://`.
+- **Other environments.** The defaults point to production (`auth.multicloud.io`, `api.multicloud.io`). For
+  another environment, set `MULTICLOUD_ISSUER_URL` (for example `https://auth.example.com/realms/multicloud`) and
+  `MULTICLOUD_API_URL` (for example `https://api.example.com`) to that environment's hosts before `mctl auth login`. Set both: the sign-in server (issuer) and the API must belong
+  to the same environment, or the API rejects the token.
+- **API key (CI, scripts).** `mctl auth login --api-key --org <team-id>`, or `MULTICLOUD_API_KEY` in the environment.
+
+## Manage CI pools
+
+A pool is a group of build machines that Multicloud starts for you and stops when they are idle.
+With an API key, reading needs **Read** access, create and update need **Write**, and delete, hibernate and wake need **Admin**.
+With an SSO sign-in, reading needs team membership and the rest needs the owner role.
+Every command takes `--org <team-id>` (also before the command: `mctl --org acme pool list`) and, where it makes
+sense, `--json` for the raw answer. `pool list` and `cloud-account list` take `-q` (only the IDs) and
+`--no-headers`. Data goes to stdout; progress and questions go to stderr.
+`<pool>` is the number from `mctl pool list` or the exact pool name.
+
+```bash
+mctl pool classes                                  # the machine sizes you can ask for
+mctl pool create ci --github-org my-gh-org --max-cost-per-hour 2 --classes cpu-4 \
+  --clouds '[{"type":"AWS","regions":["us-east-1"]}]'
+mctl pool list
+mctl pool hibernate ci                             # pause: no machines, no cost, the name stays
+mctl pool wake ci --wait --timeout 15m             # exit 0 ready, 5 timeout, 6 pool deleted, 1 other error
+```
+
+| Command | What it does |
+|---|---|
+| `mctl pool create <name>` | Make a pool. Use `--from-file pool.json` for the full request, or the flags `--github-org`, `--clouds`, `--classes`, `--max-cost-per-hour`, `--spot-policy`, `--cpu-units-requests`, `--image-by-class`, `--egress-by-class`, `--class-headroom`. A repeated run with the same `--idempotency-key` makes one pool. Put cloud keys in the file, not on the command line. |
+| `mctl pool update <pool>` | Change `--max-cost-per-hour`, `--classes`, `--spot-policy`, `--cpu-units-requests` or `--clouds`. Only the options you give change. |
+| `mctl pool show <pool>` / `cluster <pool>` | The pool, or its machines and their cost. |
+| `mctl pool hibernate <pool>` / `wake <pool>` | Pause or resume a pool. |
+| `mctl pool delete <pool> [-y]` | Delete a pool for good. It asks first; without a terminal, `-y` is required. To pause a pool, use `hibernate`. |
+| `mctl pool rotate-credentials <pool>` / `rotation-status <pool>` | Renew the pool's access credentials; show the progress of the last renewal. |
+
+## Find servers and prices
+
+The catalog lists the servers of AWS, Azure and Google Cloud with prices. An API key needs the **Catalog** access
+(`catalog` scope); `MULTICLOUD_API_KEY` needs no `--org`. Filter names are the API names: `--min-vcpus` and
+`--min_vcpus` both work. Data goes to stdout; the page line (`Page 1 of 3, 42 results.`) goes to stderr.
+
+```bash
+mctl catalog search --provider aws --min-vcpus 8 --max-price-per-hour 0.5 --sort-by vcpus
+mctl catalog search --has-accelerator --accelerator-name 'A100.*' --price-type SPOT -q   # only the IDs
+mctl catalog show 11
+mctl catalog compare 11 12 13
+mctl catalog locations --provider aws
+mctl catalog providers
+mctl catalog field-values                          # the values the filters accept
+```
+
+Every command takes `--json`. See [docs/reference.md](docs/reference.md) for all options.
+
+## Use it from an AI agent
+
+The skill `multicloud-connect-aws` in [multicloud/skills](https://github.com/multicloud/skills) teaches an agent
+such as Claude Code to run these commands. The agent asks you before each apply and never sees the key or the code.
+
+## More
+
+Every command shows its options with `--help` or `-h`, for example `mctl pool create -h`.
+The exit codes, shell completion and all options are in the [command reference](docs/reference.md):
+0 ok, 1 error, 2 usage, 3 sign-in or access, 4 not found, 5 still pending or wait timeout, 6 pool gone.
+
+License: Apache-2.0.

multicloud_cli-0.1.0/multicloud_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

multicloud_cli-0.1.0/multicloud_cli/api.py

@@ -0,0 +1,152 @@
+"""One HTTP call to the Multicloud API, shared by the command groups.
+
+The URL is ``{api_url}/api/v1/orgs/{slug}{path}``, or ``{api_url}/api/v1{path}`` for an ``org_scoped=False`` call
+(the catalog). The credential is, in this order: ``MULTICLOUD_API_KEY``,
+the SSO session (``Authorization: Bearer``), the stored API key (``X-API-Key``). It travels only to the https
+URL that ``config.get_api_url`` accepted.
+"""
+import os
+from typing import Any, Dict, Iterable, Optional, Tuple
+from urllib.parse import quote
+
+import requests
+
+from . import auth, config, exitcodes, sso
+
+TIMEOUT_S = 30
+
+
+class ApiError(Exception):
+    """The call failed. ``status`` is the HTTP status, or None when there was no answer.
+    ``exit_code`` is the exit code of ``mctl`` for it (see ``exitcodes``)."""
+
+    def __init__(self, message: str, status: Optional[int] = None, exit_code: Optional[int] = None):
+        super().__init__(message)
+        self.status = status
+        self.exit_code = exit_code if exit_code is not None else exitcodes.for_status(status)
+
+
+def _detail_text(data: Any) -> Optional[str]:
+    """The text of a Multicloud API error body: ``detail: {code, message}``, ``detail: {error: {message}}``,
+    ``detail: "<text>"`` or the list of a 422 validation error."""
+    detail = data.get("detail") if isinstance(data, dict) else None
+    if isinstance(detail, str):
+        return detail or None
+    if isinstance(detail, dict):
+        inner = detail.get("error")
+        if isinstance(inner, dict):
+            detail = inner
+        if detail.get("message"):
+            code = detail.get("code")
+            return f"{code}: {detail['message']}" if code else str(detail["message"])
+        if detail.get("code"):
+            return str(detail["code"])
+    if isinstance(detail, list):
+        parts = []
+        for item in detail:
+            if isinstance(item, dict) and item.get("msg"):
+                where = ".".join(str(p) for p in item.get("loc", []) if p != "body")
+                parts.append(f"{where}: {item['msg']}" if where else str(item["msg"]))
+        return "; ".join(parts) or None
+    return None
+
+
+def _send(method: str, url: str, body: Optional[Dict[str, Any]], headers: Dict[str, str],
+          params: Optional[Dict[str, Any]] = None) -> requests.Response:
+    extra = {"params": params} if params else {}  # a list value becomes one repeated key
+    try:
+        # No redirects: requests would carry the credential header to another host.
+        return requests.request(method, url, json=body, timeout=TIMEOUT_S, allow_redirects=False, headers=headers,
+                                **extra)
+    except requests.RequestException as ex:
+        raise ApiError(f"Could not reach the API: {ex}")
+
+
+def _sso_org(slug: Optional[str], token: str, explicit: bool = True) -> str:
+    """The organization of this call: ``--org`` (or env, or saved) when it is in the token, else the only one.
+    A SAVED org that the token lacks (left from an API-key login) is ignored; an explicit one is an error."""
+    orgs = sso.orgs_in_token(token)
+    if slug and not explicit and slug not in orgs:
+        slug = None
+    if not orgs:
+        raise auth.AuthError("Your sign-in holds no organization. Ask an owner of your organization to add you, "
+                             "then run: mctl auth login")
+    if slug:
+        if slug not in orgs:
+            raise auth.AuthError(f"You are not a member of '{slug}'. Your organizations: {', '.join(orgs)}.")
+        return slug
+    if len(orgs) > 1:
+        raise auth.AuthError(f"You belong to several organizations ({', '.join(orgs)}). "
+                             "Name one with --org or MULTICLOUD_ORG.")
+    return orgs[0]
+
+
+def call(method: str, org: Optional[str], path: str = "", *, body: Optional[Dict[str, Any]] = None,
+         headers: Optional[Dict[str, str]] = None, accept: Iterable[int] = (200, 201, 202),
+         scope: Optional[str] = None, pass_codes: Iterable[str] = (),
+         params: Optional[Dict[str, Any]] = None, org_scoped: bool = True) -> Dict[str, Any]:
+    """One API call. Returns the JSON body with ``_status`` added; raises ``ApiError`` on other statuses.
+
+    ``scope`` names the API key scope this call needs; a 401 or 403 then says that it may be missing.
+    A failed answer whose error code is in ``pass_codes`` is returned like a success.
+    ``params`` are query parameters. ``org_scoped=False`` calls ``/api/v1{path}`` with no organization in the URL:
+    an SSO call then needs no organization, and ``MULTICLOUD_API_KEY`` needs none either (a stored key still
+    needs one to be found)."""
+    slug = config.get_org(org)
+    try:
+        use_sso = False
+        if not os.environ.get("MULTICLOUD_API_KEY"):  # the key path needs no issuer
+            issuer = config.get_issuer()
+            use_sso = auth.load_sso(issuer) is not None
+            if use_sso and not org_scoped and slug and auth.get_key(slug)[0]:
+                # A stored key of the named org wins for the platform routes (the catalog): it holds its scope
+                # explicitly, while an SSO token may not reach them.
+                use_sso = False
+        base = config.get_api_url()
+        if use_sso:
+            token = auth.fresh_access_token(issuer)
+            if org_scoped:
+                slug = _sso_org(slug, token, explicit=config.org_is_explicit(org))
+            credential = {"Authorization": f"Bearer {token}"}
+        else:
+            env_key = os.environ.get("MULTICLOUD_API_KEY")
+            if not slug and not org_scoped and not env_key:
+                raise ApiError("No sign-in. Run: mctl auth login (or set MULTICLOUD_API_KEY, or name the "
+                               "organization of a stored key with --org).", exit_code=exitcodes.AUTH)
+            if not slug and org_scoped:
+                raise ApiError("Name the organization with --org or MULTICLOUD_ORG.")
+            key = auth.get_key(slug)[0] if slug else env_key
+            if not key:
+                raise ApiError(f"No sign-in for {slug}. Run: mctl auth login", exit_code=exitcodes.AUTH)
+            credential = {"X-API-Key": key}
+    except auth.AuthError as ex:
+        raise ApiError(str(ex), exit_code=exitcodes.AUTH)
+    except config.ConfigError as ex:
+        raise ApiError(str(ex))
+    url = f"{base}/api/v1/orgs/{quote(slug, safe='')}{path}" if org_scoped else f"{base}/api/v1{path}"
+    r = _send(method, url, body, {**credential, **(headers or {})}, params)
+    if r.status_code == 401 and use_sso:
+        # The access token was refused (the session may have ended on the server): refresh once and retry once.
+        try:
+            token = auth.fresh_access_token(issuer, rejected=token)
+        except auth.AuthError as ex:
+            raise ApiError(str(ex), 401)
+        r = _send(method, url, body, {"Authorization": f"Bearer {token}", **(headers or {})}, params)
+    try:
+        data = r.json() if r.text else {}
+    except ValueError:
+        data = {}
+    if r.status_code not in accept:
+        detail = data.get("detail") if isinstance(data, dict) else None
+        if isinstance(detail, dict) and detail.get("code") in set(pass_codes):
+            data = dict(data)
+            data["_status"] = r.status_code
+            return data
+        text = _detail_text(data) or f"HTTP {r.status_code}"
+        # A 401 is a bad or expired credential, not a missing scope.
+        if r.status_code == 403 and scope and not use_sso:
+            text += f" (HTTP {r.status_code}. The API key may lack the '{scope}' scope.)"
+        raise ApiError(text, r.status_code)
+    data = dict(data) if isinstance(data, dict) else {"body": data}
+    data["_status"] = r.status_code
+    return data