@arbol-ai/cli 0.0.0-stage → 1.20261018.212151
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +149 -2
- package/dist/index.js +65870 -0
- package/package.json +58 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,150 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @arbol-ai/cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`arbol`, the Arbol API from your terminal. Its commands are generated by
|
|
4
|
+
[Cloudflare Forge](https://github.com/cloudflare/forge) from the platform's public OpenAPI,
|
|
5
|
+
[`https://api.getarbol.com/openapi.json`](https://api.getarbol.com/openapi.json), and every request
|
|
6
|
+
goes through [`@arbol-ai/sdk`](https://www.npmjs.com/package/@arbol-ai/sdk). A release's version is
|
|
7
|
+
the date and time it was built (`1.YYYYMMDD.HHMMSS`, UTC); `arbol --version` also names the API release
|
|
8
|
+
its commands were generated from.
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
npm install --global @arbol-ai/cli
|
|
12
|
+
arbol --version
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
It needs Node.js 26 or newer, whose `fetch` and `Temporal` the SDK uses.
|
|
16
|
+
|
|
17
|
+
## Profiles
|
|
18
|
+
|
|
19
|
+
A profile is a named way to call Arbol: a login, or an API key. Commands use the profile `--profile`
|
|
20
|
+
names, else the one `ARBOL_PROFILE` names, else the default profile; `arbol auth use <profile>` changes
|
|
21
|
+
the default.
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
arbol auth login # a login, saved as the default profile
|
|
25
|
+
arbol auth login --profile clinic # another login, for another account or organization
|
|
26
|
+
arbol auth api-key --profile ci < /secure/path/arbol-key
|
|
27
|
+
arbol auth profiles # * marks the default
|
|
28
|
+
arbol auth use ci
|
|
29
|
+
arbol visoft clinics list --profile clinic
|
|
30
|
+
ARBOL_PROFILE=ci arbol sura appointments list
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
An API key given to one command, through `--api-key-stdin` or `ARBOL_API_KEY`, wins over every
|
|
34
|
+
profile, as `GH_TOKEN` does for `gh`: scripts, servers and CI can run without saving anything.
|
|
35
|
+
When `arbol auth login` without `--profile` signs in as someone else, or to another organization,
|
|
36
|
+
than the default profile is, it asks where the login goes: a new profile (it suggests a name from the
|
|
37
|
+
organization), in place of the profile, or beside it in the same profile (`arbol auth switch` moves
|
|
38
|
+
between them). In a script it saves nothing and asks for `--profile` instead. `--profile <name>`
|
|
39
|
+
always saves the login in that profile.
|
|
40
|
+
|
|
41
|
+
`arbol auth status` prints which credential is in use and, for a login, its organization;
|
|
42
|
+
`arbol auth logout` signs a login out, or forgets a profile's API key (the key itself works until it
|
|
43
|
+
is revoked in Arbol Account).
|
|
44
|
+
|
|
45
|
+
## Login
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
arbol auth login
|
|
49
|
+
arbol sura appointments list --help
|
|
50
|
+
arbol agenda appointments list --from 2026-10-12T00:00:00Z
|
|
51
|
+
arbol auth switch [<name|org_…>]
|
|
52
|
+
arbol auth status
|
|
53
|
+
arbol auth logout
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
The CLI knows only the API's origin (`https://api.getarbol.com`, or the one `ARBOL_API_URL` names),
|
|
57
|
+
and discovers how to sign in from it, as an MCP client does:
|
|
58
|
+
|
|
59
|
+
1. `/.well-known/oauth-protected-resource` (RFC 9728) names the resource tokens are issued for and the
|
|
60
|
+
authorization server, whose own metadata names its endpoints and keys.
|
|
61
|
+
2. `/.well-known/oauth-client/arbol-cli` (RFC 7591 client metadata) names the CLI's public client (no
|
|
62
|
+
secret), the loopback address a login returns to, and the scopes to ask for.
|
|
63
|
+
|
|
64
|
+
Login then opens the system browser (Authorization Code with S256 PKCE and the loopback callback,
|
|
65
|
+
`http://127.0.0.1:43817/callback`). When you belong to several organizations, the sign-in page asks
|
|
66
|
+
which one after you sign in. `arbol auth switch` lists the organizations you belong to: one you used
|
|
67
|
+
before switches at once, any other signs in again through single sign-on, which asks for no password.
|
|
68
|
+
`arbol auth switch <name|org_…>` does the same without asking, for scripts. The session is for the
|
|
69
|
+
organization the verified ID token names.
|
|
70
|
+
|
|
71
|
+
The scopes asked for are every permission of the API's release, because a token's authority is its
|
|
72
|
+
scopes intersected with the person's role permissions; `ARBOL_SCOPES` replaces them. Asking for a
|
|
73
|
+
scope does not grant it.
|
|
74
|
+
|
|
75
|
+
The CLI verifies state, nonce and S256 PKCE and the ID token's signature and organization.
|
|
76
|
+
`--no-browser` prints the URL for manual opening but still uses the loopback callback on this machine.
|
|
77
|
+
|
|
78
|
+
## Where sessions and keys are kept
|
|
79
|
+
|
|
80
|
+
`~/.arbol/config.json` (mode 0600) holds the profiles and the default, and no secret. Each login's
|
|
81
|
+
session and each saved API key is a sealed file under `~/.arbol/` (mode 0700 directories, 0600
|
|
82
|
+
files): AES-256-GCM under one random key per person and machine, which the OS keeps. Profile, issuer,
|
|
83
|
+
client, audience, API, user and organization partition sessions, and each file is bound to its name.
|
|
84
|
+
There is no plaintext fallback.
|
|
85
|
+
|
|
86
|
+
| OS | The key |
|
|
87
|
+
| ------- | ------------------------------------------------------------------------------------------ |
|
|
88
|
+
| macOS | Keychain item "Arbol CLI" (`com.getarbol.cli`, `session-key`), kept by `/usr/bin/security` |
|
|
89
|
+
| Linux | Secret Service, through `secret-tool` (package `libsecret-tools`) |
|
|
90
|
+
| Windows | `~/.arbol/session-key.dpapi`, protected by DPAPI for the Windows user |
|
|
91
|
+
|
|
92
|
+
The OS is asked for the key once per command and written to only once, when the key is created; a
|
|
93
|
+
refresh rewrites only the sealed file. On macOS the Keychain trusts the program that created an item.
|
|
94
|
+
Node from Homebrew, nvm or fnm is signed ad hoc, so CLIs that use the Keychain from Node ask for the
|
|
95
|
+
login password again after every Node update. `/usr/bin/security` is signed by Apple and stays trusted,
|
|
96
|
+
as it does for `gh`, so the CLI never asks. Like `gh`, any program running as you can read the key
|
|
97
|
+
through it; another user, a backup or a stolen disk cannot. The key never appears in a command line.
|
|
98
|
+
|
|
99
|
+
Each refresh is locked across processes. Before a rotating exchange the keyring records an
|
|
100
|
+
in-progress marker. A lost response or crash requires a fresh login, never a blind retry with the
|
|
101
|
+
previous refresh token. A stale `.lock` after a crashed process is removed only after confirming that
|
|
102
|
+
process stopped; then log in again. Logout removes local credentials even if remote revocation fails
|
|
103
|
+
and reports that uncertainty. It does not pretend already-issued tokens vanish immediately.
|
|
104
|
+
|
|
105
|
+
## Machines and operation input
|
|
106
|
+
|
|
107
|
+
An API key is created in Arbol Account for one organization and shown once. A key is never accepted
|
|
108
|
+
as a command-line argument: `arbol auth api-key` reads it from stdin (or asks for it without showing
|
|
109
|
+
it), checks it against the API and seals it; `--api-key-stdin` and `ARBOL_API_KEY` use one for a
|
|
110
|
+
single command without saving it. A refused key never falls back to a login.
|
|
111
|
+
|
|
112
|
+
```sh
|
|
113
|
+
ARBOL_API_KEY="$(cat /secure/path/arbol-key)" arbol visoft clinics list
|
|
114
|
+
arbol sura appointments list --api-key-stdin < /secure/path/arbol-key
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Commands are `arbol <service> <resource> <verb> [id]`, the operation's public name. `arbol <service>`
|
|
118
|
+
lists a service's commands; `--help` after one prints its fields, the values each accepts, their
|
|
119
|
+
defaults and an example. `--dry-run` prints the request a command would send (method, URL and body)
|
|
120
|
+
without reading a credential or sending anything. A deletion asks for confirmation on a terminal; a
|
|
121
|
+
script passes `--yes`.
|
|
122
|
+
|
|
123
|
+
Each input field is a flag (`--integration-id sura`), or the whole input comes from
|
|
124
|
+
`--input file.json` (`--input -` reads stdin; flags override its fields; with `--api-key-stdin`, use a
|
|
125
|
+
file). The CLI validates the input against the operation's exact schema before sending it. The
|
|
126
|
+
response's data is printed as JSON; a failure prints its code and the request id and, for a write
|
|
127
|
+
that got no answer, that its outcome is unknown, and exits nonzero. Nothing is retried, even after 401
|
|
128
|
+
or 403; reconcile an uncertain write before repeating it.
|
|
129
|
+
|
|
130
|
+
`ARBOL_API_URL` selects a trusted nonproduction deployment for new profiles and for an API key given
|
|
131
|
+
to a command; it must be an HTTPS origin. Everything else about signing in is discovered from it, and a
|
|
132
|
+
profile keeps the API it was created for.
|
|
133
|
+
|
|
134
|
+
## Development
|
|
135
|
+
|
|
136
|
+
```sh
|
|
137
|
+
bun install
|
|
138
|
+
bun run forge # build the pinned Cloudflare Forge with cargo into .forge/ (once; needs Rust)
|
|
139
|
+
bun run openapi # download https://api.getarbol.com/openapi.json
|
|
140
|
+
bun run generate # src/generated/ from openapi.json with the plugin in generation/plugins/cli.ts
|
|
141
|
+
bun run verify # typecheck, tests and dist/
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
`src/generated/` is the plugin's output, unedited; everything else in `src/` is the CLI itself.
|
|
145
|
+
`openapi.json` is downloaded at generation time and not committed, and `src/generated/generation.json`
|
|
146
|
+
records which release, Forge commit and plugin wrote each file.
|
|
147
|
+
|
|
148
|
+
## License
|
|
149
|
+
|
|
150
|
+
[Apache License 2.0](LICENSE)
|