@ekanos/cli 0.6.0 → 0.8.0

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.
@@ -41,6 +41,26 @@ the default is HTTP Basic (`'client_secret_basic'`), but a provider that wants
41
41
  harness derives the rest — provider host, redirect URI, scopes, PKCE — from
42
42
  `defineIntegration({ oauth })`, so do not repeat those in `notes`.
43
43
 
44
+ Also declare the same guidance **on the connection itself** for the hosted
45
+ product — `setup` in `defineIntegration({ oauth: { … } })` (and on each
46
+ `oauthConnections` entry). That is what a Source admin sees in `ekanos apps`
47
+ and a team sees in its setup panel once the integration is live:
48
+
49
+ ```ts
50
+ setup: {
51
+ consoleUrl: 'https://<provider developer console>/apps/new',
52
+ steps: [
53
+ 'Create an app and set its callback URL to {callbackUrl}.',
54
+ 'Enable the scopes {scopes}.',
55
+ 'Copy <the console's name for the client id> and <for the secret>.',
56
+ ],
57
+ },
58
+ ```
59
+
60
+ Ekanos fills `{callbackUrl}` and `{scopes}`; write the console's own words
61
+ for everything else. `ekanos validate` warns (`oauth.setup-missing`) about
62
+ a connection without it.
63
+
44
64
  ## What the harness then shows (so you can point the user at it)
45
65
 
46
66
  The Activation surface (`npx ekanos dev` → `http://localhost:3100/<slug>/activation`)
@@ -29,19 +29,19 @@ docs — ask, or check the CLI.
29
29
 
30
30
  ## Seats: who can use the CLI on a Source
31
31
 
32
- `npx ekanos sources --json` lists the user's seats.
32
+ `npx @ekanos/cli sources --json` lists the user's seats.
33
33
 
34
34
  | Seat | Can |
35
35
  |---|---|
36
36
  | `developer` | Submit integrations; read the catalog; apply agent **drafts** |
37
- | `source_admin` | Everything a developer can, plus **publish** agents to every team and manage the Source's roster |
37
+ | `source_admin` | Everything a developer can, plus **publish** agents to every team, set up the Source's **provider apps** (`ekanos apps`), and manage the Source's roster |
38
38
 
39
39
  Only an Ekanos super admin grants seats. If the user lacks the seat a step
40
40
  needs, say which and stop — there is no way around it from the CLI.
41
41
 
42
42
  ## Products: integrations and experiences
43
43
 
44
- Everything in the catalog (`npx ekanos catalog --source <slug> --json`) is a
44
+ Everything in the catalog (`npx @ekanos/cli catalog --source <slug> --json`) is a
45
45
  **product** of one of two kinds:
46
46
 
47
47
  - **Integration** — a connection to a third party (Linear, Zendesk, Slack…).
@@ -70,6 +70,14 @@ Ask them in this order; each catalog product reports where it stands
70
70
  into a chat or a file.
71
71
  4. **Used by an agent** — granted in the agent's tools.
72
72
 
73
+ Some integrations sign every team in through **one app for the whole Source**
74
+ (Linear's OAuth app, say): until the Source has its credentials, no team can
75
+ connect (`setupSteps` step `provider-app`). A Source admin sets it up —
76
+ `ekanos apps show <product>` gives the callback URL to register with the
77
+ provider, and `ekanos apps set <product>`, run by the admin at their own
78
+ terminal, takes the client ID and secret. Integrations whose teams each bring
79
+ their own app (Zendesk) have no Source app.
80
+
73
81
  A product that is "enabled" is not therefore "connected". Say which one you
74
82
  mean.
75
83
 
@@ -95,4 +103,5 @@ The `build-agent` skill walks through choosing between these and building one.
95
103
  | Making a product available to a Source; granting seats | Ekanos super admin, in Ekanos's admin |
96
104
  | Building or updating an integration | A developer, with `ekanos validate` / `ekanos publish` |
97
105
  | Agents provided for every team | A Source admin, with `ekanos agents` |
106
+ | An integration's app for the whole Source (client ID and secret) | A Source admin, with `ekanos apps set` at their own terminal |
98
107
  | Connecting an integration; turning on a provided agent; its triggers | Each team, in the app |