@arbol-ai/cli 0.0.0-stage → 1.20261017.200040

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,143 @@
-# Temporary Holding Version
+# @arbol-ai/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.
+`arbol`, the Arbol API from your terminal. Its commands are generated by
+[Cloudflare Forge](https://github.com/cloudflare/forge) from the platform's public OpenAPI,
+[`https://api.getarbol.com/openapi.json`](https://api.getarbol.com/openapi.json), and every request
+goes through [`@arbol-ai/sdk`](https://www.npmjs.com/package/@arbol-ai/sdk). The package's version is
+the API release its commands were generated from (`1.YYYYMMDD.n`).
+
+```sh
+npm install --global @arbol-ai/cli
+arbol --version
+```
+
+It needs Node.js 26 or newer, whose `fetch` and `Temporal` the SDK uses.
+
+## Profiles
+
+A profile is a named way to call Arbol: a login, or an API key. Commands use the profile `--profile`
+names, else the one `ARBOL_PROFILE` names, else the default profile; `arbol auth use <profile>` changes
+the default.
+
+```sh
+arbol auth login                                  # a login, saved as the default profile
+arbol auth login --profile clinic                 # another login, for another account or organization
+arbol auth api-key --profile ci < /secure/path/arbol-key
+arbol auth profiles                               # * marks the default
+arbol auth use ci
+arbol visoft clinics list --profile clinic
+ARBOL_PROFILE=ci arbol sura appointments list
+```
+
+An API key given to one command, through `--api-key-stdin` or `ARBOL_API_KEY`, wins over every
+profile, as `GH_TOKEN` does for `gh`: scripts, servers and CI can run without saving anything.
+`arbol auth status` prints which credential is in use and, for a login, its organization;
+`arbol auth logout` signs a login out, or forgets a profile's API key (the key itself works until it
+is revoked in Arbol Account).
+
+## Login
+
+```sh
+arbol auth login
+arbol sura appointments list --help
+arbol agenda appointments list --from 2026-10-12T00:00:00Z
+arbol auth switch [<name|org_…>]
+arbol auth status
+arbol auth logout
+```
+
+The CLI knows only the API's origin (`https://api.getarbol.com`, or the one `ARBOL_API_URL` names),
+and discovers how to sign in from it, as an MCP client does:
+
+1. `/.well-known/oauth-protected-resource` (RFC 9728) names the resource tokens are issued for and the
+   authorization server, whose own metadata names its endpoints and keys.
+2. `/.well-known/oauth-client/arbol-cli` (RFC 7591 client metadata) names the CLI's public client (no
+   secret), the loopback address a login returns to, and the scopes to ask for.
+
+Login then opens the system browser (Authorization Code with S256 PKCE and the loopback callback,
+`http://127.0.0.1:43817/callback`). When you belong to several organizations, the sign-in page asks
+which one after you sign in. `arbol auth switch` lists the organizations you belong to: one you used
+before switches at once, any other signs in again through single sign-on, which asks for no password.
+`arbol auth switch <name|org_…>` does the same without asking, for scripts. The session is for the
+organization the verified ID token names.
+
+The scopes asked for are every permission of the API's release, because a token's authority is its
+scopes intersected with the person's role permissions; `ARBOL_SCOPES` replaces them. Asking for a
+scope does not grant it.
+
+The CLI verifies state, nonce and S256 PKCE and the ID token's signature and organization.
+`--no-browser` prints the URL for manual opening but still uses the loopback callback on this machine.
+
+## Where sessions and keys are kept
+
+`~/.arbol/config.json` (mode 0600) holds the profiles and the default, and no secret. Each login's
+session and each saved API key is a sealed file under `~/.arbol/` (mode 0700 directories, 0600
+files): AES-256-GCM under one random key per person and machine, which the OS keeps. Profile, issuer,
+client, audience, API, user and organization partition sessions, and each file is bound to its name.
+There is no plaintext fallback.
+
+| OS      | The key                                                                                    |
+| ------- | ------------------------------------------------------------------------------------------ |
+| macOS   | Keychain item "Arbol CLI" (`com.getarbol.cli`, `session-key`), kept by `/usr/bin/security` |
+| Linux   | Secret Service, through `secret-tool` (package `libsecret-tools`)                          |
+| Windows | `~/.arbol/session-key.dpapi`, protected by DPAPI for the Windows user                      |
+
+The OS is asked for the key once per command and written to only once, when the key is created; a
+refresh rewrites only the sealed file. On macOS the Keychain trusts the program that created an item.
+Node from Homebrew, nvm or fnm is signed ad hoc, so CLIs that use the Keychain from Node ask for the
+login password again after every Node update. `/usr/bin/security` is signed by Apple and stays trusted,
+as it does for `gh`, so the CLI never asks. Like `gh`, any program running as you can read the key
+through it; another user, a backup or a stolen disk cannot. The key never appears in a command line.
+
+Each refresh is locked across processes. Before a rotating exchange the keyring records an
+in-progress marker. A lost response or crash requires a fresh login, never a blind retry with the
+previous refresh token. A stale `.lock` after a crashed process is removed only after confirming that
+process stopped; then log in again. Logout removes local credentials even if remote revocation fails
+and reports that uncertainty. It does not pretend already-issued tokens vanish immediately.
+
+## Machines and operation input
+
+An API key is created in Arbol Account for one organization and shown once. A key is never accepted
+as a command-line argument: `arbol auth api-key` reads it from stdin (or asks for it without showing
+it), checks it against the API and seals it; `--api-key-stdin` and `ARBOL_API_KEY` use one for a
+single command without saving it. A refused key never falls back to a login.
+
+```sh
+ARBOL_API_KEY="$(cat /secure/path/arbol-key)" arbol visoft clinics list
+arbol sura appointments list --api-key-stdin < /secure/path/arbol-key
+```
+
+Commands are `arbol <service> <resource> <verb> [id]`, the operation's public name. `arbol <service>`
+lists a service's commands; `--help` after one prints its fields, the values each accepts, their
+defaults and an example. `--dry-run` prints the request a command would send (method, URL and body)
+without reading a credential or sending anything. A deletion asks for confirmation on a terminal; a
+script passes `--yes`.
+
+Each input field is a flag (`--integration-id sura`), or the whole input comes from
+`--input file.json` (`--input -` reads stdin; flags override its fields; with `--api-key-stdin`, use a
+file). The CLI validates the input against the operation's exact schema before sending it. The
+response's data is printed as JSON; a failure prints its code and the request id and, for a write
+that got no answer, that its outcome is unknown, and exits nonzero. Nothing is retried, even after 401
+or 403; reconcile an uncertain write before repeating it.
+
+`ARBOL_API_URL` selects a trusted nonproduction deployment for new profiles and for an API key given
+to a command; it must be an HTTPS origin. Everything else about signing in is discovered from it, and a
+profile keeps the API it was created for.
+
+## Development
+
+```sh
+bun install
+bun run forge       # build the pinned Cloudflare Forge with cargo into .forge/ (once; needs Rust)
+bun run openapi     # download https://api.getarbol.com/openapi.json
+bun run generate    # src/generated/ from openapi.json with the plugin in generation/plugins/cli.ts
+bun run verify      # typecheck, tests and dist/
+```
+
+`src/generated/` is the plugin's output, unedited; everything else in `src/` is the CLI itself.
+`openapi.json` is downloaded at generation time and not committed, and `src/generated/generation.json`
+records which release, Forge commit and plugin wrote each file.
+
+## License
+
+[Apache License 2.0](LICENSE)