@native-engagement/cli 0.8.0 → 0.8.1
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 +39 -9
- package/dist/index.js +22 -3
- package/package.json +1 -1
- package/release.json +2 -2
package/README.md
CHANGED
|
@@ -1,24 +1,54 @@
|
|
|
1
1
|
# Native Engagement CLI
|
|
2
2
|
|
|
3
|
-
Node.js 24.22.1+ (24 LTS)
|
|
3
|
+
Node.js 24.22.1+ (24 LTS) client for the Native Engagement HTTPS service.
|
|
4
4
|
|
|
5
5
|
```sh
|
|
6
|
-
npm install
|
|
7
|
-
native-engagement --help
|
|
6
|
+
npm install --global @native-engagement/cli@0.8.1
|
|
8
7
|
native-engagement --version
|
|
9
8
|
native-engagement login
|
|
10
9
|
native-engagement auth status
|
|
11
|
-
npx @native-engagement/cli@beta contracts list
|
|
12
10
|
```
|
|
13
11
|
|
|
14
|
-
|
|
12
|
+
## Account and password sign-in
|
|
13
|
+
|
|
14
|
+
`login` opens your system browser. Enter your account, password and any MFA challenge on the identity service's page and approve the requested permissions. OAuth Authorization Code with S256 PKCE returns the result to the CLI on loopback. A current browser SSO session can avoid repeated password entry. Your administrator must provision your account and tenant permissions first.
|
|
15
|
+
|
|
16
|
+
The default center is https://engagement.shipkitx.com. Use `NATIVE_ENGAGEMENT_API_URL` for another trusted HTTPS center. The browser callback must reach the machine running the CLI. For an application-managed browser on macOS/Linux, run `native-engagement login --no-open`: stderr reports the path of a private `authorization-url.txt` file. Open its URL in a browser on this machine; the file is removed on completion or cancellation. Authorization URLs and passwords are not printed in command results. `NATIVE_ENGAGEMENT_CLI_HOME` selects an absolute private current-user directory.
|
|
17
|
+
|
|
18
|
+
The access grant uses a private current-user file on macOS/Linux and current-user DPAPI on Windows. Refresh tokens are not persisted. Run `login` again after expiry. `native-engagement logout` revokes and removes the grant. Login requests engagement read/write, work read, asset read and message draft, intersected with current tenant permissions. Desktop installation and identity administration use their own authorization.
|
|
19
|
+
|
|
20
|
+
For automation, supply a separately authorized short-lived `NATIVE_ENGAGEMENT_BEARER_TOKEN` through the protected environment. Password, token and principal overrides are not accepted in argv. An npm publishing token is unrelated to service login.
|
|
21
|
+
|
|
22
|
+
## Complete prospect workflow
|
|
15
23
|
|
|
16
24
|
```sh
|
|
17
|
-
native-engagement schema get
|
|
18
|
-
native-engagement
|
|
25
|
+
native-engagement schema get prospect.batch.import
|
|
26
|
+
native-engagement prospect preview --input @import.json
|
|
27
|
+
native-engagement prospect import --input @import.json
|
|
28
|
+
native-engagement prospect batch --input @batch.json
|
|
29
|
+
native-engagement prospect company --input @company.json
|
|
30
|
+
native-engagement prospect engage --input @engage.json
|
|
31
|
+
native-engagement prospect engagements --input @association.json
|
|
32
|
+
native-engagement prospect batches --input @page.json
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Inputs follow the canonical schemas from `schema get`. `import.json` supports country, industry, address, contact name/title and original score in each row's optional `profile`; the SDK README has a complete input. Source URLs are optional; provide an actual credential-free HTTP(S) page when known. Preserve source reference/version, observation time and current/historical status. Original research and verification stay with their owner; Native stores observations and receipts.
|
|
36
|
+
|
|
37
|
+
`batch.json`: `{"batchRef":"YOUR_BATCH_REF"}`. `company.json`: `{"prospectRef":"YOUR_EXACT_PROSPECT_REF"}`. `engage.json` selects the exact imported CURRENT contact/source observation and supplies an engagement reference, why-fit/why-now and stable idempotency key. Creating an engagement does not send or schedule work. Retry an unchanged input with its original key.
|
|
38
|
+
|
|
39
|
+
`association.json`: `{"prospectRef":"YOUR_EXACT_PROSPECT_REF","limit":20}`; pass returned `nextCursor` as `cursor`. `page.json`: `{"offset":0,"limit":20}`; continue with `nextOffset` until null. Batch history has no 100-total cap; responses contain at most 100 records. `prospect list` queries the company catalog.
|
|
40
|
+
|
|
41
|
+
```sh
|
|
42
|
+
native-engagement contracts list
|
|
43
|
+
native-engagement query <contract-name> --input @request.json
|
|
19
44
|
native-engagement command <contract-name> --input @command.json
|
|
45
|
+
npx @native-engagement/cli@0.8.1 --help
|
|
20
46
|
```
|
|
21
47
|
|
|
22
|
-
|
|
48
|
+
Results are JSON: exit 0 success, 2 rejected input/access, 1 unavailable. Unknown external effects require original-operation inspection before retrying. Local execution nodes and channel authorization use the Desktop installation flow.
|
|
49
|
+
|
|
50
|
+
## MCP OAuth
|
|
51
|
+
|
|
52
|
+
Connect your MCP host to `https://engagement.shipkitx.com/mcp` using Streamable HTTP and OAuth. It discovers the authorization server from the 401 resource-metadata challenge, opens its own browser sign-in and receives its own grant. The center currently uses pre-registered MCP clients with exact registered callbacks. Ask your administrator to register the host first if it has no client configuration; the CLI client identifier is reserved for the CLI/SDK loopback flow. Current directory permissions govern each MCP call.
|
|
23
53
|
|
|
24
|
-
This
|
|
54
|
+
This beta uses license `UNLICENSED`. [Complete account and OAuth guide](https://engagement.shipkitx.com/releases/authentication.md) · [Downloads](https://engagement.shipkitx.com/downloads)
|