xevol 0.12.6 → 0.12.8
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 +38 -3
- package/dist/index.js +271 -245
- 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 Leads, Contacts, and
|
|
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,25 +53,50 @@ 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 offers ...` — every Offers procedure used by Xevol Work Web, including profiles, status, snapshots, audiences, angles, artifacts, revisions, and reviewed generation
|
|
56
57
|
- `xevol leads ...` — every Leads procedure used by Xevol Work Web, including campaigns, review, identity, packets, Deal handoff, outreach, learning, import, insights, and export
|
|
58
|
+
- `xevol deals ...` — list, get, create, update, and stage management
|
|
59
|
+
- `xevol activities ...` — record timelines, counts, personal tasks, activity creation, and task completion
|
|
60
|
+
- `xevol search [query]` — search Companies, Contacts, and Deals across the selected Workspace
|
|
57
61
|
|
|
58
|
-
Every procedure is a first-class kebab-case subcommand. Use `xevol <group> --help` for the complete list. Common creation has direct flags:
|
|
62
|
+
Every grouped procedure is a first-class kebab-case subcommand; Search is a direct command. Use `xevol <group> --help` for the complete list. Common creation has direct flags:
|
|
59
63
|
|
|
60
64
|
```bash
|
|
61
65
|
xevol companies create --name Acme --domain acme.com --json
|
|
62
66
|
xevol contacts create --first-name Ada --email ada@acme.com --company-id <company-id> --json
|
|
63
67
|
xevol leads create --campaign-id <campaign-id> --source MANUAL --company Acme --domain acme.com --json
|
|
68
|
+
xevol deals create --name "Acme renewal" --company-id <company-id> --owner-id <user-id> --amount-cents 125000 --currency USD --json
|
|
69
|
+
xevol activities create --type TASK --subject "Follow up" --deal-id <deal-id> --due-at 2026-09-01T09:00:00Z --json
|
|
70
|
+
xevol search Acme --json
|
|
64
71
|
```
|
|
65
72
|
|
|
66
73
|
Complex or less common inputs still accept exactly one of `--input`, `--file`, or stdin:
|
|
67
74
|
|
|
68
75
|
```bash
|
|
76
|
+
xevol offers create --input '{"offerProfileId":"...","kind":"SERVICE","name":"Fixed package"}' --json
|
|
69
77
|
xevol leads packet-decide --input '{"packetId":"...","action":"QUALIFY"}' --json
|
|
70
78
|
xevol leads packet-decide --file decision.json --json
|
|
71
79
|
cat decision.json | xevol leads packet-decide --json
|
|
72
80
|
```
|
|
73
81
|
|
|
74
|
-
List commands also accept `--query`, `--page`, `--page-size`, `--sort`, and `--dir`. `--workspace-id` overrides the selected Workspace for one command while still relying on server-side membership authorization.
|
|
82
|
+
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.
|
|
83
|
+
|
|
84
|
+
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.
|
|
85
|
+
|
|
86
|
+
### Bounded system workflow
|
|
87
|
+
|
|
88
|
+
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:
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
xevol system plan -f system.json --json
|
|
92
|
+
xevol system approve -f system.json --plan-hash <hash> --confirm "APPROVE_SYSTEM_PLAN:<hash>" --operation-key <key> --json
|
|
93
|
+
xevol system apply -f system.json --approval-id <id> --approval-token <token> --operation-key <key> --json
|
|
94
|
+
xevol system verify -f system.json --json
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
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.
|
|
98
|
+
|
|
99
|
+
Work and system commands return `xevol.cli/v1` envelopes in `--json` mode and keep normal handled errors off stderr.
|
|
75
100
|
|
|
76
101
|
### Ingestion & content
|
|
77
102
|
- `xevol add [url]` — URL ingestion (YouTube + non-YouTube); omit URL when using `--batch`
|
|
@@ -95,6 +120,16 @@ List commands also accept `--query`, `--page`, `--page-size`, `--sort`, and `--d
|
|
|
95
120
|
- `xevol coordinates locations` — Xevol Coordinates history
|
|
96
121
|
- `xevol whereami` / `xevol locations` — legacy convenience aliases
|
|
97
122
|
|
|
123
|
+
### Workspace Agent skills
|
|
124
|
+
- `xevol skills list` — list accessible active reviewed skill revisions
|
|
125
|
+
- `xevol skills search <query>` — search accessible skill names and descriptions
|
|
126
|
+
- `xevol skills get <skill-id> --revision <revision-id>` — read one exact revision
|
|
127
|
+
- `xevol skills export <skill-id> --revision <revision-id> --output <directory>` — create a local text-only Agent Skills package without overwriting files
|
|
128
|
+
|
|
129
|
+
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.
|
|
130
|
+
|
|
131
|
+
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.
|
|
132
|
+
|
|
98
133
|
### Interface
|
|
99
134
|
- `xevol agent-help` — machine-oriented guide for agents/scripts using xevol-cli
|
|
100
135
|
- `xevol agent-help --json` — structured command/workflow guide for agents
|