xevol 0.13.0 → 0.14.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 +46 -4
- package/dist/index.js +283 -275
- 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
|
|
5
|
+
Use it to manage Xevol Work Ads; operate 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
|
|
|
@@ -47,11 +47,13 @@ xevol workspace switch <workspace-id>
|
|
|
47
47
|
|
|
48
48
|
### Auth
|
|
49
49
|
- `xevol login` — device auth flow (or `--token` for headless/CI)
|
|
50
|
+
- `xevol connect <codex|claude|pi|other> [--workspace <id>]` — connect an AI app to Xevol's MCP server in one step. You approve with a code in any browser, so it works over SSH; the app gets limited agent access (read and draft in one Workspace) and is listed under Settings → Connected AI agents. `other` prints the URL and header for any other MCP client.
|
|
50
51
|
- `xevol login --agent --workspace <id>` — limited access for an AI agent (Claude Code, Codex): one Workspace, read and draft, never approve, send, publish or delete. Give agents this token, never the full one. Disconnect it in Settings.
|
|
51
52
|
- `xevol logout` — revoke token + clear local config
|
|
52
53
|
- `xevol whoami` — current authenticated account
|
|
53
54
|
|
|
54
|
-
### Xevol Work
|
|
55
|
+
### Xevol Work
|
|
56
|
+
- `xevol ads ...` — manage Ads projects, collections, creatives, formats, copy, links, status, archives, and history
|
|
55
57
|
- `xevol companies ...` — all Companies reads and commands: list, get, options, create, update, remove, enrich, research, and primary Contact
|
|
56
58
|
- `xevol contacts ...` — all Contacts reads and commands: list, get, create, update, and proposed-fact decisions
|
|
57
59
|
- `xevol offers ...` — every Offers procedure used by Xevol Work Web, including profiles, status, snapshots, audiences, angles, artifacts, revisions, and reviewed generation
|
|
@@ -86,6 +88,45 @@ List commands also accept `--query`, `--page`, `--page-size`, `--sort`, and `--d
|
|
|
86
88
|
|
|
87
89
|
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.
|
|
88
90
|
|
|
91
|
+
### Ads manager
|
|
92
|
+
|
|
93
|
+
Ads commands mirror the `ads.*` Work manager. They create and edit native records, upload
|
|
94
|
+
formats, change status, archive and restore, and expose append-only change history. They
|
|
95
|
+
do not run the operator importer, generate creative, publish, or manage ad-platform
|
|
96
|
+
campaigns, targeting, budgets, spend, or attribution.
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
xevol ads projects --json
|
|
100
|
+
xevol ads compare <left-creative-id> --right-id <right-creative-id> --json
|
|
101
|
+
xevol ads project-create --name OwnScreen --json
|
|
102
|
+
xevol ads create --project-id <project-id> --title "Shop-window film" --kind motion --language en --json
|
|
103
|
+
xevol ads update <creative-id> --destination https://example.test --json
|
|
104
|
+
xevol ads upload <creative-id> film.mp4 --name "4:5 film" --width 1080 --height 1350 --duration 15 --json
|
|
105
|
+
xevol ads copy-add <creative-id> --content "Turn any TV into a sign" --json
|
|
106
|
+
xevol ads status <creative-id> --status Live --note "AU+NZ" --json
|
|
107
|
+
xevol ads archive <creative-id> --entity creative --json
|
|
108
|
+
xevol ads restore <creative-id> --entity creative --json
|
|
109
|
+
xevol ads history <creative-id> --json
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
`ads update` and `ads status` fetch the creative's current `updatedAt` when
|
|
113
|
+
`--updated-at` is omitted. Other edits require the `updatedAt` read from the API, passed
|
|
114
|
+
through `--updated-at` or JSON, so concurrent changes return `CONFLICT` instead of being
|
|
115
|
+
overwritten. `ads upload` accepts PNG, JPEG, WebP, GIF and MP4 files up to 64 MiB; it
|
|
116
|
+
handles the grant, byte upload, and direct-upload finalization as one command.
|
|
117
|
+
|
|
118
|
+
Read commands remain available: `projects`, `list`, `get`, `documents`, `compare`, and
|
|
119
|
+
`history`. `ads list` supports `--category`, `--kind image|motion|mixed`, `--label`,
|
|
120
|
+
`--language`, `--creative-type`, `--medium`, and common paging/search flags. Its sort
|
|
121
|
+
fields are `title`, `category`, `label`, `language`, and `creativeType`. The project
|
|
122
|
+
filter uses the stable `sourceId` returned by `ads projects`; `ads documents` uses that
|
|
123
|
+
project's record `id`.
|
|
124
|
+
|
|
125
|
+
Editorial status and archive presence do not prove publication, performance, platform
|
|
126
|
+
approval, or reuse rights. The selected Workspace and Ads module gate still apply.
|
|
127
|
+
Workspace-bound agent access may create, edit, link and upload. It cannot run `status`,
|
|
128
|
+
`archive`, or `restore`; those decisions require a full OWNER or MEMBER session.
|
|
129
|
+
|
|
89
130
|
### Imported source data
|
|
90
131
|
|
|
91
132
|
Directory and Career source commands use the same Work API token, selected Workspace,
|
|
@@ -181,8 +222,9 @@ Add, upload, status, and retry use the selected Work Workspace's Creator gateway
|
|
|
181
222
|
- `xevol resume <transcriptionId>` — resume interrupted stream session
|
|
182
223
|
- `xevol prompts ...` — prompt CRUD/list/get
|
|
183
224
|
|
|
184
|
-
### Usage, exports, locations
|
|
225
|
+
### Usage, billing, exports, locations
|
|
185
226
|
- `xevol usage` — plan + usage snapshot
|
|
227
|
+
- `xevol billing [--workspace-id <id>] [--json]` — read the Workspace credit balance, monthly use, enforcement policy, and waiting-work count
|
|
186
228
|
- `xevol export <id> --format json|markdown|text` — export content locally
|
|
187
229
|
- `xevol coordinates current` — latest Xevol Coordinates context, with coordinates hidden unless `--exact`
|
|
188
230
|
- `xevol coordinates current --json` — stable machine-readable current context for scripts/agents
|
|
@@ -200,7 +242,7 @@ Use `--agent-id` and `--agent-revision` together only when reading a legitimatel
|
|
|
200
242
|
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.
|
|
201
243
|
|
|
202
244
|
### Interface
|
|
203
|
-
- `xevol agent-help` —
|
|
245
|
+
- `xevol agent-help` — guide for AI agents with agent access: what they can read and draft, and what only people decide
|
|
204
246
|
- `xevol agent-help --json` — structured command/workflow guide for agents
|
|
205
247
|
- `xevol tui` — interactive terminal UI
|
|
206
248
|
|