xevol 0.12.7 → 0.12.9
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 +99 -2
- package/dist/index.js +272 -246
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Terminal client for Xevol content execution.
|
|
4
4
|
|
|
5
|
-
Use it to operate Xevol Work
|
|
5
|
+
Use it to operate Xevol Work Offers, Leads, Contacts, Companies, Deals, Activities, tasks, and search; ingest content; run analysis; manage prompts; inspect usage; and work across Workspaces.
|
|
6
6
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
@@ -53,7 +53,10 @@ xevol workspace switch <workspace-id>
|
|
|
53
53
|
### Xevol Work CRM
|
|
54
54
|
- `xevol companies ...` — all Companies reads and commands: list, get, options, create, update, remove, enrich, research, and primary Contact
|
|
55
55
|
- `xevol contacts ...` — all Contacts reads and commands: list, get, create, update, and proposed-fact decisions
|
|
56
|
-
- `xevol
|
|
56
|
+
- `xevol offers ...` — every Offers procedure used by Xevol Work Web, including profiles, status, snapshots, audiences, angles, artifacts, revisions, and reviewed generation
|
|
57
|
+
- `xevol leads ...` — every Leads procedure used by Xevol Work Web, including campaigns, manual imported review, identity, packets, Deal handoff, outreach, learning, import, insights, and export
|
|
58
|
+
- `xevol directory ...` — read-only Company/Contact source browsing, identity quality, memberships, and immutable import reports
|
|
59
|
+
- `xevol career ...` — read-only source job browsing and detail, separate from personal Matches and Pursuits
|
|
57
60
|
- `xevol deals ...` — list, get, create, update, and stage management
|
|
58
61
|
- `xevol activities ...` — record timelines, counts, personal tasks, activity creation, and task completion
|
|
59
62
|
- `xevol search [query]` — search Companies, Contacts, and Deals across the selected Workspace
|
|
@@ -72,6 +75,7 @@ xevol search Acme --json
|
|
|
72
75
|
Complex or less common inputs still accept exactly one of `--input`, `--file`, or stdin:
|
|
73
76
|
|
|
74
77
|
```bash
|
|
78
|
+
xevol offers create --input '{"offerProfileId":"...","kind":"SERVICE","name":"Fixed package"}' --json
|
|
75
79
|
xevol leads packet-decide --input '{"packetId":"...","action":"QUALIFY"}' --json
|
|
76
80
|
xevol leads packet-decide --file decision.json --json
|
|
77
81
|
cat decision.json | xevol leads packet-decide --json
|
|
@@ -79,8 +83,91 @@ cat decision.json | xevol leads packet-decide --json
|
|
|
79
83
|
|
|
80
84
|
List commands also accept `--query`, `--page`, `--page-size`, `--sort`, and `--dir`. Deal lists add status, owner, stage, and closing-window facets. Activity commands provide direct timeline anchors, filters, task windows, and limits. `--workspace-id` overrides the selected Workspace for one command while still relying on server-side membership authorization.
|
|
81
85
|
|
|
86
|
+
Campaign execution commands keep the Work API's reviewed-policy and acknowledgement requirements. In particular, `campaign-execution-activate` can start sending and requires both `expectedEnrollmentCount` and `"acknowledgeSend": true`; the CLI supplies no bypass and the API rechecks current Workspace authority.
|
|
87
|
+
|
|
88
|
+
### Imported source data
|
|
89
|
+
|
|
90
|
+
Directory and Career source commands use the same Work API token, selected Workspace,
|
|
91
|
+
active membership, and direct-owner privacy checks as the web. They do not execute bulk
|
|
92
|
+
imports, enrich records, enroll campaigns, send messages, or apply for jobs.
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
xevol directory companies --source explee --query Acme --page-size 25 --json
|
|
96
|
+
xevol directory contacts --source explee --missing email --quality weak --json
|
|
97
|
+
xevol directory company-get <company-id> --json
|
|
98
|
+
xevol directory contact-get <contact-id> --json
|
|
99
|
+
xevol directory sources <record-id> --kind CONTACT --page-size 25 --json
|
|
100
|
+
xevol directory source-options --kind CONTACT --json
|
|
101
|
+
xevol directory imports --state COMPLETED --json
|
|
102
|
+
xevol directory import-get <batch-id> --json
|
|
103
|
+
xevol directory import-rows <batch-id> --kind CONTACT --outcome UNRESOLVED --json
|
|
104
|
+
xevol directory import-row-get <row-id> --batch-id <batch-id> --json
|
|
105
|
+
xevol career source-list --source leadjobs --query engineer --age historical-365 --json
|
|
106
|
+
xevol career source-get <opportunity-id> --json
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Directory lists support `--source`, `--snapshot`, `--segment`, `--quality`, `--usage`,
|
|
110
|
+
and `--missing`. Import reports filter by source/state; source rows filter by kind/outcome.
|
|
111
|
+
Career source lists support `--source`, `--availability`, `--age`, and `--work-mode`.
|
|
112
|
+
Searchable lists accept `--query`, `--sort`, and `--dir`; paged reads accept `--page`
|
|
113
|
+
and `--page-size` (1–100). `source-options` returns the accessible filter values.
|
|
114
|
+
Observed job availability is historical evidence, not proof that a job is open now.
|
|
115
|
+
|
|
116
|
+
### Imported manual Leads review
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
xevol leads list --input '{"view":"all"}' --json
|
|
120
|
+
xevol leads manual-campaign-resolve <source-campaign-id> --json
|
|
121
|
+
xevol leads manual-campaign-detail <campaign-id> --json
|
|
122
|
+
xevol leads manual-prospect-list <campaign-id> --disposition HELD --json
|
|
123
|
+
xevol leads manual-lead-detail <lead-id> --campaign-id <campaign-id> --json
|
|
124
|
+
xevol leads manual-draft-list <lead-id> --campaign-id <campaign-id> --json
|
|
125
|
+
xevol leads manual-draft-detail <draft-id> --campaign-id <campaign-id> --lead-id <lead-id> --json
|
|
126
|
+
xevol leads manual-source-catalog --json
|
|
127
|
+
xevol leads manual-source-rows --source-table DRAFTS --page-size 25 --json
|
|
128
|
+
xevol leads manual-source-record <row-id> --json
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
`leads list` defaults to submissions; use `view: all` when counting the full Lead corpus.
|
|
132
|
+
Manual review mutations are **content-only**: approval never schedules or sends a message.
|
|
133
|
+
They reuse the API's version, campaign, owner, archive, and replay checks without bypasses:
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
xevol leads manual-lead-review <lead-id> --file review.json --json
|
|
137
|
+
xevol leads manual-draft-revise <draft-id> --file revision.json --json
|
|
138
|
+
xevol leads manual-draft-decide <draft-id> --file content-decision.json --json
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
All three input files must supply `campaignId`, the exact observed `expectedVersion`, and
|
|
142
|
+
an explicit `operationKey`. Review additionally needs `disposition` and `reason`.
|
|
143
|
+
Revision needs `leadId`, `parentRevision`, `subject`, and `body`. Decision needs `leadId`,
|
|
144
|
+
`revision`, and `decision` (`APPROVE` or `REJECT`); rejection requires `note`.
|
|
145
|
+
IDs supplied positionally cannot conflict with JSON input. Context can also be provided
|
|
146
|
+
with `--campaign-id`, `--lead-id` (draft commands), `--expected-version`, and `--operation-key`.
|
|
147
|
+
No version or approval is inferred. Retain exact draft revisions and read server results
|
|
148
|
+
before issuing another command. Bulk migration and provider actions remain separate operations.
|
|
149
|
+
|
|
150
|
+
### Bounded system workflow
|
|
151
|
+
|
|
152
|
+
A strict `xevol.system/v1` JSON manifest can manage one Offer profile, up to two reviewed Offers, up to two manual campaigns, and up to five reviewed Leads:
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
xevol system plan -f system.json --json
|
|
156
|
+
xevol system approve -f system.json --plan-hash <hash> --confirm "APPROVE_SYSTEM_PLAN:<hash>" --operation-key <key> --json
|
|
157
|
+
xevol system apply -f system.json --approval-id <id> --approval-token <token> --operation-key <key> --json
|
|
158
|
+
xevol system verify -f system.json --json
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
Planning and verification are read-only. Approval is bound to the exact manifest and observed state. Apply is atomic and replay-safe. V1 permits no campaign run, outreach, provider write, publication, or external cost, and provides no `--yes` or `--force` bypass.
|
|
162
|
+
|
|
163
|
+
Work and system commands return `xevol.cli/v1` envelopes in `--json` mode and keep normal handled errors off stderr.
|
|
164
|
+
|
|
82
165
|
### Ingestion & content
|
|
83
166
|
- `xevol add [url]` — URL ingestion (YouTube + non-YouTube); omit URL when using `--batch`
|
|
167
|
+
- `xevol add --file source.pdf --lang en` — upload PDF, UTF-8 text, audio, or video
|
|
168
|
+
- `xevol retry <id> --regenerate --lang en` — regenerate saved content on the same transcription
|
|
169
|
+
|
|
170
|
+
Add, upload, status, and retry use the selected Work Workspace's Creator gateway. Retained authority still routes to Creator; exclusive Native authority uses canonical Work ingestion. Use `--operation-id <id>` on a single add/upload/retry to repeat an uncertain response without starting another import. Audio/video requires the Agent's optional ASR configuration.
|
|
84
171
|
- `xevol create [text]` — create from text/file/url/stdin/editor
|
|
85
172
|
- `xevol list` — list transcriptions
|
|
86
173
|
- `xevol view <id>` — view summary/content
|
|
@@ -101,6 +188,16 @@ List commands also accept `--query`, `--page`, `--page-size`, `--sort`, and `--d
|
|
|
101
188
|
- `xevol coordinates locations` — Xevol Coordinates history
|
|
102
189
|
- `xevol whereami` / `xevol locations` — legacy convenience aliases
|
|
103
190
|
|
|
191
|
+
### Workspace Agent skills
|
|
192
|
+
- `xevol skills list` — list accessible active reviewed skill revisions
|
|
193
|
+
- `xevol skills search <query>` — search accessible skill names and descriptions
|
|
194
|
+
- `xevol skills get <skill-id> --revision <revision-id>` — read one exact revision
|
|
195
|
+
- `xevol skills export <skill-id> --revision <revision-id> --output <directory>` — create a local text-only Agent Skills package without overwriting files
|
|
196
|
+
|
|
197
|
+
Use `--agent-id` and `--agent-revision` together only when reading a legitimately pinned archived revision. Skill instructions do not grant tools, data access, or permission to act. Exported Workspace material cannot be recalled and may be private.
|
|
198
|
+
|
|
199
|
+
These commands require a Work API release that provides `agentSkills.discover` and `agentSkills.readRevision`. An older server returns `UNSUPPORTED_SERVER`; the CLI never falls back to the administrative skill-history surface.
|
|
200
|
+
|
|
104
201
|
### Interface
|
|
105
202
|
- `xevol agent-help` — machine-oriented guide for agents/scripts using xevol-cli
|
|
106
203
|
- `xevol agent-help --json` — structured command/workflow guide for agents
|