xevol 0.12.5 → 0.12.7
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 +44 -6
- package/dist/index.js +231 -214
- package/package.json +2 -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 ingest content
|
|
5
|
+
Use it to operate Xevol Work CRM records, Deals, Activities, tasks, and search; ingest content; run analysis; manage prompts; inspect usage; and work across Workspaces.
|
|
6
6
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
@@ -41,7 +41,7 @@ xevol workspace list
|
|
|
41
41
|
xevol workspace switch <workspace-id>
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
|
|
44
|
+
`workspace list` and `workspace switch` use the Xevol Work API. The selected Work `workspaceId` is injected into Work commands and cannot be replaced by JSON input. When Creator is enabled, switching also records its mapped Creator Workspace ID for legacy content routes.
|
|
45
45
|
|
|
46
46
|
## Command map
|
|
47
47
|
|
|
@@ -50,8 +50,37 @@ When a workspace is selected, CLI sends `X-Workspace-Id` automatically for works
|
|
|
50
50
|
- `xevol logout` — revoke token + clear local config
|
|
51
51
|
- `xevol whoami` — current authenticated account
|
|
52
52
|
|
|
53
|
+
### Xevol Work CRM
|
|
54
|
+
- `xevol companies ...` — all Companies reads and commands: list, get, options, create, update, remove, enrich, research, and primary Contact
|
|
55
|
+
- `xevol contacts ...` — all Contacts reads and commands: list, get, create, update, and proposed-fact decisions
|
|
56
|
+
- `xevol leads ...` — every Leads procedure used by Xevol Work Web, including campaigns, review, identity, packets, Deal handoff, outreach, learning, import, insights, and export
|
|
57
|
+
- `xevol deals ...` — list, get, create, update, and stage management
|
|
58
|
+
- `xevol activities ...` — record timelines, counts, personal tasks, activity creation, and task completion
|
|
59
|
+
- `xevol search [query]` — search Companies, Contacts, and Deals across the selected Workspace
|
|
60
|
+
|
|
61
|
+
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:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
xevol companies create --name Acme --domain acme.com --json
|
|
65
|
+
xevol contacts create --first-name Ada --email ada@acme.com --company-id <company-id> --json
|
|
66
|
+
xevol leads create --campaign-id <campaign-id> --source MANUAL --company Acme --domain acme.com --json
|
|
67
|
+
xevol deals create --name "Acme renewal" --company-id <company-id> --owner-id <user-id> --amount-cents 125000 --currency USD --json
|
|
68
|
+
xevol activities create --type TASK --subject "Follow up" --deal-id <deal-id> --due-at 2026-09-01T09:00:00Z --json
|
|
69
|
+
xevol search Acme --json
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Complex or less common inputs still accept exactly one of `--input`, `--file`, or stdin:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
xevol leads packet-decide --input '{"packetId":"...","action":"QUALIFY"}' --json
|
|
76
|
+
xevol leads packet-decide --file decision.json --json
|
|
77
|
+
cat decision.json | xevol leads packet-decide --json
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
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
|
+
|
|
53
82
|
### Ingestion & content
|
|
54
|
-
- `xevol add
|
|
83
|
+
- `xevol add [url]` — URL ingestion (YouTube + non-YouTube); omit URL when using `--batch`
|
|
55
84
|
- `xevol create [text]` — create from text/file/url/stdin/editor
|
|
56
85
|
- `xevol list` — list transcriptions
|
|
57
86
|
- `xevol view <id>` — view summary/content
|
|
@@ -67,10 +96,14 @@ When a workspace is selected, CLI sends `X-Workspace-Id` automatically for works
|
|
|
67
96
|
### Usage, exports, locations
|
|
68
97
|
- `xevol usage` — plan + usage snapshot
|
|
69
98
|
- `xevol export <id> --format json|markdown|text` — export content locally
|
|
70
|
-
- `xevol
|
|
71
|
-
- `xevol
|
|
99
|
+
- `xevol coordinates current` — latest Xevol Coordinates context, with coordinates hidden unless `--exact`
|
|
100
|
+
- `xevol coordinates current --json` — stable machine-readable current context for scripts/agents
|
|
101
|
+
- `xevol coordinates locations` — Xevol Coordinates history
|
|
102
|
+
- `xevol whereami` / `xevol locations` — legacy convenience aliases
|
|
72
103
|
|
|
73
104
|
### Interface
|
|
105
|
+
- `xevol agent-help` — machine-oriented guide for agents/scripts using xevol-cli
|
|
106
|
+
- `xevol agent-help --json` — structured command/workflow guide for agents
|
|
74
107
|
- `xevol tui` — interactive terminal UI
|
|
75
108
|
|
|
76
109
|
## Common flags
|
|
@@ -101,7 +134,12 @@ CLI config is stored in:
|
|
|
101
134
|
|
|
102
135
|
- `~/.xevol/config.json`
|
|
103
136
|
|
|
104
|
-
Includes token, API URL, selected
|
|
137
|
+
Includes the CLI token, Creator API URL, Work API URL, selected Work and mapped Creator Workspace IDs, and defaults.
|
|
138
|
+
|
|
139
|
+
- `XEVOL_API_URL` overrides the Creator API origin.
|
|
140
|
+
- `XEVOL_WORK_API_URL` overrides the Xevol Work origin (default `https://xevol.com`).
|
|
141
|
+
|
|
142
|
+
The same device-flow CLI token is introspected by Xevol Work and mapped through its imported Creator identity binding. Every request still passes normal active Workspace membership and module gates.
|
|
105
143
|
|
|
106
144
|
## Notes
|
|
107
145
|
|