@oddington/cli 0.1.105 → 0.1.107

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.
Files changed (3) hide show
  1. package/README.md +24 -0
  2. package/dist/os.js +387 -357
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -48,6 +48,30 @@ Run `os --help` or add `--help` to any command for the full command list.
48
48
  Commands print readable output by default. Add `--json` when another program
49
49
  will consume the result.
50
50
 
51
+ ## API clients
52
+
53
+ Manage external server-side programs as named clients of your active workspace:
54
+
55
+ ```sh
56
+ os api-client create --name "Airtable Importer" --scope inbox:publish
57
+ os api-client list
58
+ os api-client token issue --client <client-id> --scope inbox:publish --json
59
+ # Store the new token and update your program before revoking the old token.
60
+ os api-client token revoke --client <client-id> --token <old-token-id>
61
+ os api-client disable --client <client-id> --yes
62
+ ```
63
+
64
+ Creation and issuance return the secret only once (`token.secret` in JSON).
65
+ Store it securely in your server's secret store; it cannot be recovered. Lists
66
+ contain safe client and token metadata. Revoking one token preserves other
67
+ tokens; disabling a client stops all its tokens and cannot be undone. Existing
68
+ Digests retain the client's name. Use `os workspace switch` to change the active
69
+ workspace; these commands accept no workspace override. API tokens cannot be
70
+ used for CLI sign-in. The only scope is `inbox:publish`, for Digest check and
71
+ publication through `createClient` in `@oddington/sdk`.
72
+
73
+ ## Apps and connections
74
+
51
75
  `os app dev <name>` shows recent development-server output in your terminal if
52
76
  startup fails or the server later stops. It distinguishes an exit from a startup
53
77
  timeout and includes the app's retry command. This is output from your local dev