@oddington/cli 0.1.42 → 0.1.44
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/README.md +29 -6
- package/dist/os.js +211 -202
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# OS CLI
|
|
2
2
|
|
|
3
3
|
The CLI lets people and routines work with their OS from a terminal.
|
|
4
4
|
|
|
@@ -22,15 +22,38 @@ Run `os --help` or add `--help` to any command for the full command list.
|
|
|
22
22
|
Commands print readable output by default. Add `--json` when another program
|
|
23
23
|
will consume the result.
|
|
24
24
|
|
|
25
|
+
Dropbox setup uses an offline OAuth URL and hidden one-time code entry:
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
os connection create dropbox --workspace example --name os-files
|
|
29
|
+
os connection create dropbox --workspace example --name business --access full-dropbox --root "/Business"
|
|
30
|
+
os connection list --workspace example --all
|
|
31
|
+
os connection inspect --workspace example --id <returned-id>
|
|
32
|
+
os connection test --workspace example --connection dropbox/business
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
The default is App Folder, privately available to Files. Full Dropbox requires a
|
|
36
|
+
separate saved connection, OAuth application and grant, plus an explicit existing
|
|
37
|
+
folder; setup and testing only read provider state. Neither create command selects
|
|
38
|
+
File storage. Full Dropbox cannot be a File store. Its declared root is the base
|
|
39
|
+
path trusted routines must use, not provider-enforced token containment. Routine
|
|
40
|
+
Dropbox calls change provider data immediately, independently of publication.
|
|
41
|
+
Disconnect prevents new delivery but does not revoke an already delivered token.
|
|
42
|
+
The operator must register and configure separate App Folder and Full Dropbox
|
|
43
|
+
applications on the OS service. The application mode is that verified backend
|
|
44
|
+
registration, never an inference from Dropbox account namespace metadata.
|
|
45
|
+
Missing Full Dropbox setup refuses only that setup path; it does not disable App
|
|
46
|
+
Folder authorization.
|
|
47
|
+
|
|
25
48
|
Sign-in and session operations use `https://auth.oddington.ai`. Connection
|
|
26
49
|
management, repository targets, local app repository context, Dropbox authorization,
|
|
27
50
|
remote File-storage configuration and Routine deployment use `https://api.oddington.ai`. These addresses are fixed; workspace
|
|
28
|
-
configuration and `
|
|
51
|
+
configuration and `OS_ORIGIN` do not override them.
|
|
29
52
|
|
|
30
53
|
Connection use is the canonical `POST /workspaces/<workspace>/connections/use`
|
|
31
54
|
operation on the API host. The verified member or retained Run supplies authority;
|
|
32
55
|
the request names the Connection and exact Run ID. Hosted ad hoc execution needs
|
|
33
|
-
both `
|
|
56
|
+
both `OS_CONNECTION_RUN_TOKEN` and `OS_CONNECTION_RUN_ID`.
|
|
34
57
|
Inbox publication goes directly to the selected workspace's `/api/inbox/check`,
|
|
35
58
|
`/api/inbox/publish`, `/api/inbox/resolve` and `/api/inbox/files` operations.
|
|
36
59
|
Data and shared Files go directly to their OS owners. Local publication validates
|
|
@@ -320,7 +343,7 @@ Never put credentials in command arguments, logs, or issues. `inspect`, `list`,
|
|
|
320
343
|
and other CLI output never reveal saved credentials.
|
|
321
344
|
|
|
322
345
|
`os run` passes a short-lived credential to the child process in
|
|
323
|
-
`
|
|
346
|
+
`OS_CONNECTION_CREDENTIAL`. Only run trusted code, and do not print or
|
|
324
347
|
retain that value.
|
|
325
348
|
|
|
326
349
|
## Deploy routines
|
|
@@ -586,7 +609,7 @@ or attach anything. CSV parsing hints (`csv.encoding`, `csv.delimiter`,
|
|
|
586
609
|
and verified PDF pages. Unsupported files remain preserved and downloadable.
|
|
587
610
|
|
|
588
611
|
Member-authored files may use `workingRoot` in the SDK, `--working-root` on the
|
|
589
|
-
file command, or `
|
|
612
|
+
file command, or `OS_INBOX_WORKING_ROOT`. Named routine Runs receive
|
|
590
613
|
their resolved worktree root from OS. The file command defaults to the current directory:
|
|
591
614
|
|
|
592
615
|
```sh
|
|
@@ -615,7 +638,7 @@ the File; delete that use through its owning capability first. Read access does
|
|
|
615
638
|
not allow deleting another member's or an installed routine's File.
|
|
616
639
|
|
|
617
640
|
The command uses the published SDK and the CLI member session. Configured
|
|
618
|
-
`
|
|
641
|
+
`OS_FILES_ROOT` selects the existing managed local owner, including
|
|
619
642
|
uploaded-cache cleanup. Success means physical cleanup and durable completion;
|
|
620
643
|
repeating a completed command succeeds. Temporary failures remain retryable,
|
|
621
644
|
and a pending File stays inaccessible. R2 cleanup removes only the exact pinned
|