@votrix-ai/cli 0.0.0-stage → 0.2.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 +192 -2
- package/SITE-TRACKING-CLI-DESIGN.md +117 -0
- package/dist/src/agent.js +366 -0
- package/dist/src/auth.js +283 -0
- package/dist/src/cli.js +170 -0
- package/dist/src/commands.js +116 -0
- package/dist/src/core.js +373 -0
- package/dist/src/integrations.js +156 -0
- package/dist/src/site.js +278 -0
- package/dist/src/tools.js +289 -0
- package/dist/src/zip.js +112 -0
- package/docs/API.md +98 -0
- package/docs/cli/account.md +77 -0
- package/docs/cli/agent.md +105 -0
- package/docs/cli/files.md +65 -0
- package/docs/cli/integrations.md +67 -0
- package/docs/cli/media.md +45 -0
- package/docs/cli/runs.md +44 -0
- package/docs/cli/scraper.md +45 -0
- package/docs/cli/seo.md +45 -0
- package/docs/cli/site.md +137 -0
- package/docs/cli/social.md +85 -0
- package/docs/cli/ui.md +45 -0
- package/package.json +30 -4
- package/production.json +5 -0
- package/skills/votrix/SKILL.md +97 -0
- package/skills/votrix/agents/openai.yaml +4 -0
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: votrix
|
|
3
|
+
description: "Use the votrix CLI to hand work to Votrix employees and collect the files they make, run Votrix tools (generate images, video and audio; SEO data; scrape social and web data; website UI designs), publish or schedule prepared social posts, and use workspace files. Use for Votrix tasks from the terminal; source-code work alone does not require this skill."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Votrix
|
|
7
|
+
|
|
8
|
+
Run the `votrix` command (installed with `npm install -g @votrix-ai/cli`, or `npx -y @votrix-ai/cli` in its place). Every command prints one JSON object on stdout, errors included as `{"error": {"type", "message", "fix"}}`; progress goes to stderr; nothing prompts. Exit code 0 is an answer, 1 a failure, 2 bad usage. Read `error.fix` and follow it.
|
|
9
|
+
|
|
10
|
+
## Get ready
|
|
11
|
+
|
|
12
|
+
- `votrix whoami` shows the account, workspace and key in use. If it says to log in, ask the user to run `votrix login` (Google sign-in in a browser on this computer), or to create a CLI key in the Votrix App and give it to `votrix login --key vtx_...`.
|
|
13
|
+
- `votrix login` keeps one API key per workspace for this device; `votrix workspace use ID` switches. With several workspaces and none chosen, `votrix whoami` lists them. A caller with only a key sets `VOTRIX_API_KEY`; it acts in that key's workspace with its scopes.
|
|
14
|
+
- With several workspaces, pass `--workspace <id>` (from `votrix workspaces`) or set a default with `votrix workspace use <id>`.
|
|
15
|
+
- Use the saved login or the given key. Keep credential files and keys out of output.
|
|
16
|
+
|
|
17
|
+
## Choose the path
|
|
18
|
+
|
|
19
|
+
- A prepared post with approved content and accounts: `votrix tools social ...`.
|
|
20
|
+
- A generated image, video, audio clip, SEO dataset, scrape, or UI design the user describes exactly: `votrix tools <category> run ...`.
|
|
21
|
+
- Work that needs an employee's judgement and skills (a campaign, a website, a researched report), or continuing an employee conversation: `votrix agent ask ...`.
|
|
22
|
+
|
|
23
|
+
## Hand work to an employee
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
votrix agent ls
|
|
27
|
+
votrix agent ask rebecca 'Make a 30-second launch video for this product' --file ./product.png --out ./votrix-out
|
|
28
|
+
votrix agent ask rebecca 'Make it vertical' --session SESSION_ID --out ./votrix-out
|
|
29
|
+
votrix agent sessions --employee rebecca
|
|
30
|
+
votrix agent get SESSION_ID
|
|
31
|
+
votrix agent files SESSION_ID
|
|
32
|
+
votrix agent pull ASSET_ID [ASSET_ID ...] --out ./votrix-out
|
|
33
|
+
votrix agent history SESSION_ID --limit 20
|
|
34
|
+
votrix agent stop SESSION_ID
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
- `ls` gives each employee's `name`, `slug` and `role`; pick the one whose role fits. `ask` takes the name, slug or id.
|
|
38
|
+
- `ask` starts a new session unless `--session` continues one, and blocks until the whole session is done, including subagents and background jobs that wake the employee again. That can take many minutes: run it in the background and read its output when it exits. Another `ask --session` while it works is queued for the employee.
|
|
39
|
+
- The result is `{"session_id", "employee", "status", "reply", "presented"}`, for this task only. `status` is `idle` (done) or `failed`. `presented` lists the files the employee handed over in this task; with `--out` each has a local `path`. A website or video project arrives as its `.zip`.
|
|
40
|
+
- `files <session>` lists every file in the session's outputs folder (`filename`, `size_bytes`, `kind`); pull any of them by asset id.
|
|
41
|
+
- `--file` takes a local path (uploaded, at most 500 MiB) or any asset id in the workspace. For a long or multiline task pass `-` as the task and give it on stdin.
|
|
42
|
+
- `sessions` finds earlier conversations; `history` returns messages oldest first and pages back with the `before` it returns.
|
|
43
|
+
- If `ask` was cut off, the employee keeps working: `get SESSION_ID` shows where it stands. Send the task once; `stop` interrupts everything the session is doing.
|
|
44
|
+
|
|
45
|
+
## Run a tool
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
votrix tools media list
|
|
49
|
+
votrix tools media explore seedance
|
|
50
|
+
votrix tools media run seedance --mode text_to_video --prompt 'A calm sea at dawn' --duration 5 --out ./votrix-out
|
|
51
|
+
votrix tools seo list
|
|
52
|
+
votrix tools seo explore keyword_metrics
|
|
53
|
+
votrix tools seo run keyword_metrics --keywords '["restaurant pos"]'
|
|
54
|
+
votrix tools scraper list
|
|
55
|
+
votrix tools scraper run reddit-communities --topic seo
|
|
56
|
+
votrix tools scraper run reddit-posts --where r/SEO --query 'new site not ranking' --limit 20
|
|
57
|
+
votrix tools ui run design --site-type 'online sneaker store' --story 'choosing a size, then adding to cart' --out ./votrix-out
|
|
58
|
+
votrix tools runs get RUN_ID --out ./votrix-out
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
- Read the catalog first: `list` shows what each category holds today and `explore <name>` its modes, parameters, price and the exact fields it returns. Models change; use the names and aliases the catalog gives (`seedance`, `video`) rather than remembered ones.
|
|
62
|
+
- Pass parameters as `--<parameter> VALUE` (JSON values are parsed; repeat a flag for a list), or all at once with `--input '{...}'` / `--input @file.json`. A local file path as a value is uploaded for you.
|
|
63
|
+
- `run` blocks until done and returns `{"run_id", "status", "result", "files", "estimate_credits", "credits", "error"}`; `--out DIR` downloads `files`. `explore` shows `credits.at_defaults`; `--max-credits N` refuses a run estimated above N credits. A run reports `estimate_credits` and the `credits` charged. Ask for the shortest video that works first: video is billed by length and resolution.
|
|
64
|
+
- Runs spend workspace credits. Run what the user asked for, once; if a run is cut off, `votrix tools runs get RUN_ID` collects it.
|
|
65
|
+
|
|
66
|
+
## Publish social posts
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
votrix tools social accounts --platform youtube
|
|
70
|
+
votrix tools social posts create --account ACCOUNT_ID --caption 'Approved content' --media ./original.mp4 --title 'Video title'
|
|
71
|
+
votrix tools social posts create --account ACCOUNT_ID --caption 'Approved content' --media ASSET_ID --schedule-at '2030-01-01T12:00:00Z'
|
|
72
|
+
votrix tools social posts create --account ACCOUNT_ID --caption-file ./caption.txt --draft
|
|
73
|
+
votrix tools social posts update POST_ID --file ./post.json
|
|
74
|
+
votrix tools social posts list --status scheduled
|
|
75
|
+
votrix tools social posts get POST_ID
|
|
76
|
+
votrix tools social posts results POST_ID
|
|
77
|
+
votrix tools social posts cancel POST_ID
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
- Use account ids from `accounts`; repeat `--account` for several accounts. Accounts with `is_active: false` need reconnecting in the App.
|
|
81
|
+
- `--media` takes a public URL, a workspace asset id, or a local path (uploaded first); repeat it for several. `--thumbnail` sets the cover of a single video; `--title` sets a YouTube title.
|
|
82
|
+
- `create` publishes immediately unless `--draft` or a future `--schedule-at` with a timezone is given. Publish only the content, accounts and timing the user approved.
|
|
83
|
+
- `--file post.json` takes the whole request: `account_ids`, `caption`, `media` (`url` or `asset_id`, optional `thumbnail_url`/`thumbnail_asset_id`), `scheduled_at`, `draft`, `platform_configurations`, `account_configurations`.
|
|
84
|
+
- `processed` does not prove delivery: check `results` and each result's `success`. After an uncertain write, read `list`/`get` before trying again.
|
|
85
|
+
|
|
86
|
+
## Workspace files
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
votrix tools files upload ./materials.zip
|
|
90
|
+
votrix tools files get ASSET_ID
|
|
91
|
+
votrix tools files pull ASSET_ID --out ./votrix-out
|
|
92
|
+
votrix tools files library --query launch
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
`upload` registers files without sending them anywhere; pass the ids to `agent ask --file` or `--media`.
|
|
96
|
+
|
|
97
|
+
This skill is shared by Codex and Claude Code. It describes how to use the CLI; it does not authorize sending work, spending credits, or publishing beyond the user's request.
|