@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.
@@ -0,0 +1,65 @@
1
+ # Workspace files
2
+
3
+ Upload files, inspect metadata, download assets, or publish an asset at a public URL.
4
+
5
+ ## Commands
6
+
7
+ ### `votrix tools files upload`
8
+
9
+ Upload local files privately.
10
+
11
+ ```text
12
+ votrix tools files upload PATH ...
13
+ ```
14
+
15
+ Returns Asset IDs and file metadata.
16
+
17
+ ### `votrix tools files get`
18
+
19
+ Inspect file metadata.
20
+
21
+ ```text
22
+ votrix tools files get ASSET
23
+ ```
24
+
25
+ Returns File record.
26
+
27
+ ### `votrix tools files pull`
28
+
29
+ Download workspace assets.
30
+
31
+ ```text
32
+ votrix tools files pull ASSET ... [--out DIR]
33
+ ```
34
+
35
+ Returns Local paths.
36
+
37
+ ### `votrix tools files publish`
38
+
39
+ Publish a file at a permanent public URL.
40
+
41
+ ```text
42
+ votrix tools files publish ASSET|PATH --name NAME
43
+ ```
44
+
45
+ Returns Publication information.
46
+
47
+ ### `votrix tools files library`
48
+
49
+ Search saved workspace files. Default limit 50.
50
+
51
+ ```text
52
+ votrix tools files library [--query TEXT] [--mime-group GROUP ...] [--before CURSOR] [--limit N]
53
+ ```
54
+
55
+ Returns Matching file records.
56
+
57
+ ## Example
58
+
59
+ ```bash
60
+ votrix tools files upload ./brief.pdf
61
+ votrix tools files get ASSET_ID
62
+ votrix tools files pull ASSET_ID --out ./out
63
+ ```
64
+
65
+ Upload returns files and their asset IDs. Publish makes the selected file publicly accessible.
@@ -0,0 +1,67 @@
1
+ # Connected applications
2
+
3
+ Discover toolkit slugs, link an account, search for an action, inspect its schema and execute with JSON arguments.
4
+
5
+ ## Commands
6
+
7
+ ### `votrix tools integrations toolkits list`
8
+
9
+ List supported apps offline.
10
+
11
+ ```text
12
+ votrix tools integrations toolkits list
13
+ ```
14
+
15
+ Returns toolkits with name and slug.
16
+
17
+ ### `votrix tools integrations connections`
18
+
19
+ List the workspace's connected accounts.
20
+
21
+ ```text
22
+ votrix tools integrations connections [list] [--toolkit APP]
23
+ ```
24
+
25
+ Returns apps with toolkit, accounts and status. Pass an account_id to execute --account.
26
+
27
+ ### `votrix tools integrations link`
28
+
29
+ Request the hosted OAuth URL. Open the returned URL to authorize.
30
+
31
+ ```text
32
+ votrix tools integrations link APP [--no-browser] [--no-wait]
33
+ ```
34
+
35
+ Returns app, url, status, account_id and expires_at.
36
+
37
+ ### `votrix tools integrations search`
38
+
39
+ Search the live action catalog. Default limit 20.
40
+
41
+ ```text
42
+ votrix tools integrations search QUERY [--toolkit APP] [--limit N]
43
+ ```
44
+
45
+ Returns actions and needs_connection.
46
+
47
+ ### `votrix tools integrations execute`
48
+
49
+ Inspect the live schema, validate arguments or execute the action. Data defaults to {}.
50
+
51
+ ```text
52
+ votrix tools integrations execute ACTION --get-schema
53
+ votrix tools integrations execute ACTION [-d|--data JSON|@FILE|-] [--account ID] [--dry-run]
54
+ ```
55
+
56
+ Returns Schema mode returns parameters (name, type, required, description), rules that span parameters, and the raw input_schema. Dry-run checks the arguments and the account the action would run as, and returns valid and account. Execution returns ok, action and data or error.
57
+
58
+ ## Example
59
+
60
+ ```bash
61
+ votrix tools integrations toolkits list
62
+ votrix tools integrations connections --toolkit gmail
63
+ votrix tools integrations execute GMAIL_GET_PROFILE --get-schema
64
+ votrix tools integrations execute GMAIL_GET_PROFILE -d '{}'
65
+ ```
66
+
67
+ Link returns a hosted OAuth URL. Execute returns ok, action and data or an error. Supply --account ID if the workspace has several active connections for that toolkit.
@@ -0,0 +1,45 @@
1
+ # Media tools
2
+
3
+ Discover models, their modes and the parameters accepted by each.
4
+
5
+ ## Commands
6
+
7
+ ### `votrix tools media list`
8
+
9
+ Discover available tools.
10
+
11
+ ```text
12
+ votrix tools media list
13
+ ```
14
+
15
+ Returns Current catalog.
16
+
17
+ ### `votrix tools media explore`
18
+
19
+ Inspect supported parameters, outputs and price.
20
+
21
+ ```text
22
+ votrix tools media explore NAME [--mode MODE]
23
+ ```
24
+
25
+ Returns Tool description and parameter schema.
26
+
27
+ ### `votrix tools media run`
28
+
29
+ Run a tool. Explore its inputs first: explore shows credits at default settings. --max-credits refuses a run estimated above N credits, or one that cannot be priced. Waits by default.
30
+
31
+ ```text
32
+ votrix tools media run NAME [--mode MODE] [--input JSON|@FILE] [--PARAM VALUE ...] [--max-credits N] [--out DIR] [--no-wait]
33
+ ```
34
+
35
+ Returns Run ID, status, estimate_credits, credits charged, and results or files.
36
+
37
+ ## Example
38
+
39
+ ```bash
40
+ votrix tools media list
41
+ votrix tools media explore seedance
42
+ votrix tools media run seedance --mode text_to_video --prompt "A calm sea at dawn" --out ./out
43
+ ```
44
+
45
+ The run result includes status, run_id and any generated files.
@@ -0,0 +1,44 @@
1
+ # Tool runs
2
+
3
+ Use the run ID returned by a category command to inspect, wait for, or stop execution.
4
+
5
+ ## Commands
6
+
7
+ ### `votrix tools runs list`
8
+
9
+ List recent runs (default limit 20).
10
+
11
+ ```text
12
+ votrix tools runs list [--category NAME] [--limit N]
13
+ ```
14
+
15
+ Returns Run records.
16
+
17
+ ### `votrix tools runs get`
18
+
19
+ Wait for a run or return its current state.
20
+
21
+ ```text
22
+ votrix tools runs get ID [--out DIR] [--no-wait]
23
+ ```
24
+
25
+ Returns Run status and available outputs.
26
+
27
+ ### `votrix tools runs stop`
28
+
29
+ Stop a run.
30
+
31
+ ```text
32
+ votrix tools runs stop ID
33
+ ```
34
+
35
+ Returns Run status.
36
+
37
+ ## Example
38
+
39
+ ```bash
40
+ votrix tools runs list --category media
41
+ votrix tools runs get RUN_ID --no-wait
42
+ ```
43
+
44
+ Get returns the current run. By default it waits for completion and --out downloads output files.
@@ -0,0 +1,45 @@
1
+ # Scraper tools
2
+
3
+ Choose a source and inspect its input and response fields.
4
+
5
+ ## Commands
6
+
7
+ ### `votrix tools scraper list`
8
+
9
+ Discover available tools.
10
+
11
+ ```text
12
+ votrix tools scraper list
13
+ ```
14
+
15
+ Returns Current catalog.
16
+
17
+ ### `votrix tools scraper explore`
18
+
19
+ Inspect supported parameters, outputs and price.
20
+
21
+ ```text
22
+ votrix tools scraper explore NAME [--mode MODE]
23
+ ```
24
+
25
+ Returns Tool description and parameter schema.
26
+
27
+ ### `votrix tools scraper run`
28
+
29
+ Run a tool. Explore its inputs first: explore shows credits at default settings. --max-credits refuses a run estimated above N credits, or one that cannot be priced. Waits by default.
30
+
31
+ ```text
32
+ votrix tools scraper run NAME [--mode MODE] [--input JSON|@FILE] [--PARAM VALUE ...] [--max-credits N] [--out DIR] [--no-wait]
33
+ ```
34
+
35
+ Returns Run ID, status, estimate_credits, credits charged, and results or files.
36
+
37
+ ## Example
38
+
39
+ ```bash
40
+ votrix tools scraper list
41
+ votrix tools scraper explore reddit-posts
42
+ votrix tools scraper run reddit-posts --where r/SEO --query "site ranking" --limit 20
43
+ ```
44
+
45
+ The run returns its status and source-specific results.
@@ -0,0 +1,45 @@
1
+ # SEO tools
2
+
3
+ Inspect a dataset before supplying keywords or domains.
4
+
5
+ ## Commands
6
+
7
+ ### `votrix tools seo list`
8
+
9
+ Discover available tools.
10
+
11
+ ```text
12
+ votrix tools seo list
13
+ ```
14
+
15
+ Returns Current catalog.
16
+
17
+ ### `votrix tools seo explore`
18
+
19
+ Inspect supported parameters, outputs and price.
20
+
21
+ ```text
22
+ votrix tools seo explore NAME [--mode MODE]
23
+ ```
24
+
25
+ Returns Tool description and parameter schema.
26
+
27
+ ### `votrix tools seo run`
28
+
29
+ Run a tool. Explore its inputs first: explore shows credits at default settings. --max-credits refuses a run estimated above N credits, or one that cannot be priced. Waits by default.
30
+
31
+ ```text
32
+ votrix tools seo run NAME [--mode MODE] [--input JSON|@FILE] [--PARAM VALUE ...] [--max-credits N] [--out DIR] [--no-wait]
33
+ ```
34
+
35
+ Returns Run ID, status, estimate_credits, credits charged, and results or files.
36
+
37
+ ## Example
38
+
39
+ ```bash
40
+ votrix tools seo list
41
+ votrix tools seo explore keyword_metrics
42
+ votrix tools seo run keyword_metrics --keywords '["restaurant pos"]'
43
+ ```
44
+
45
+ Read the returns schema from explore for the fields in each result row.
@@ -0,0 +1,137 @@
1
+ # Website deployment
2
+
3
+ Deploy a directory containing index.html, a zip archive, or a previously uploaded archive.
4
+
5
+ ## Commands
6
+
7
+ ### `votrix tools site list`
8
+
9
+ List workspace sites.
10
+
11
+ ```text
12
+ votrix tools site list
13
+ ```
14
+
15
+ Returns Sites, addresses and live versions.
16
+
17
+ ### `votrix tools site deploy`
18
+
19
+ Deploy a version or restore an earlier one. Waits by default.
20
+
21
+ ```text
22
+ votrix tools site deploy DIR|ZIP --name SITE [--address SUB] [--no-track] [--no-wait]
23
+ votrix tools site deploy --asset ID --name SITE [--no-track] [--no-wait]
24
+ votrix tools site deploy --name SITE --version N [--no-wait]
25
+ ```
26
+
27
+ Returns Site, version, deployment status and available tracking metadata.
28
+
29
+ ### `votrix tools site versions`
30
+
31
+ List deployment versions.
32
+
33
+ ```text
34
+ votrix tools site versions SITE
35
+ ```
36
+
37
+ Returns Version history and live version.
38
+
39
+ ### `votrix tools site status`
40
+
41
+ Inspect deployment progress.
42
+
43
+ ```text
44
+ votrix tools site status SITE [--version N] [--logs]
45
+ ```
46
+
47
+ Returns Deployment status and optional logs.
48
+
49
+ ### `votrix tools site env list`
50
+
51
+ List environment variable names.
52
+
53
+ ```text
54
+ votrix tools site env list SITE
55
+ ```
56
+
57
+ Returns Variable names.
58
+
59
+ ### `votrix tools site env set`
60
+
61
+ Read KEY=VALUE lines from file or stdin. Default target is all.
62
+
63
+ ```text
64
+ votrix tools site env set SITE --from-file FILE|- [--target production|preview|all]
65
+ ```
66
+
67
+ Returns Environment update result.
68
+
69
+ ### `votrix tools site domain add`
70
+
71
+ Connect a custom domain.
72
+
73
+ ```text
74
+ votrix tools site domain add SITE DOMAIN
75
+ ```
76
+
77
+ Returns Domain status and DNS information.
78
+
79
+ ### `votrix tools site domain status`
80
+
81
+ Check domain status.
82
+
83
+ ```text
84
+ votrix tools site domain status SITE DOMAIN
85
+ ```
86
+
87
+ Returns Domain status and DNS information.
88
+
89
+ ### `votrix tools site track enable`
90
+
91
+ Enable or upgrade visitor tracking.
92
+
93
+ ```text
94
+ votrix tools site track enable SITE
95
+ ```
96
+
97
+ Returns Tracking state and changed flag. A change may redeploy the live version.
98
+
99
+ ### `votrix tools site track disable`
100
+
101
+ Disable visitor tracking.
102
+
103
+ ```text
104
+ votrix tools site track disable SITE
105
+ ```
106
+
107
+ Returns Tracking state and changed flag. A change may redeploy the live version.
108
+
109
+ ### `votrix tools site track events`
110
+
111
+ Discover recorded names or group events. Defaults to 30d, grouped by name, limit 50 (max 200). Grouping by another field defaults to visit.
112
+
113
+ ```text
114
+ votrix tools site track events SITE [--period 7d|30d|90d] [--by FIELD] [--where FIELD=VALUE[,VALUE...] ...] [--event NAME] [--search TEXT] [--limit N]
115
+ ```
116
+
117
+ Returns data_status and rows with visitors and event count.
118
+
119
+ ### `votrix tools site track funnel`
120
+
121
+ Count distinct browsers completing 2-5 steps in order. Defaults to period 30d and window 7d. Filters and grouping apply to the first step.
122
+
123
+ ```text
124
+ votrix tools site track funnel SITE --steps NAME,NAME[,NAME...] [--period 7d|30d|90d] [--by FIELD] [--where FIELD=VALUE[,VALUE...] ...] [--window 1h|1d|7d|30d]
125
+ ```
126
+
127
+ Returns data_status and steps (or groups) with visitors, of_previous_percent and of_first_percent.
128
+
129
+ ## Example
130
+
131
+ ```bash
132
+ votrix tools site deploy ./website --name my-site
133
+ votrix tools site versions my-site
134
+ votrix tools site status my-site
135
+ ```
136
+
137
+ Deployment returns site, version, status and deployment metadata. See [visitor analytics](../../SITE-TRACKING-CLI-DESIGN.md) for instrumentation and funnel reports.
@@ -0,0 +1,85 @@
1
+ # Social publishing
2
+
3
+ Select a connected social account and use its account ID in a draft or scheduled post.
4
+
5
+ ## Commands
6
+
7
+ ### `votrix tools social accounts`
8
+
9
+ List connected social accounts.
10
+
11
+ ```text
12
+ votrix tools social accounts [--platform NAME]
13
+ ```
14
+
15
+ Returns accounts array.
16
+
17
+ ### `votrix tools social posts create`
18
+
19
+ Create posts from a JSON file or account and content flags.
20
+
21
+ ```text
22
+ votrix tools social posts create [--file JSON_FILE|-] [--account ID ...] [--caption TEXT|--caption-file FILE] [--media URL|PATH|ASSET ...] [--thumbnail X] [--title TEXT] [--schedule-at TIME|--draft]
23
+ ```
24
+
25
+ Returns Created post records.
26
+
27
+ ### `votrix tools social posts update`
28
+
29
+ Update a post.
30
+
31
+ ```text
32
+ votrix tools social posts update ID [--file JSON_FILE|-] [--account ID ...] [--caption TEXT|--caption-file FILE] [--media URL|PATH|ASSET ...] [--thumbnail X] [--title TEXT] [--schedule-at TIME|--draft]
33
+ ```
34
+
35
+ Returns Updated post record.
36
+
37
+ ### `votrix tools social posts list`
38
+
39
+ List posts (default limit 50, offset 0).
40
+
41
+ ```text
42
+ votrix tools social posts list [--account ID ...] [--status STATUS ...] [--limit N] [--offset N]
43
+ ```
44
+
45
+ Returns Post records.
46
+
47
+ ### `votrix tools social posts get`
48
+
49
+ Inspect a post.
50
+
51
+ ```text
52
+ votrix tools social posts get ID
53
+ ```
54
+
55
+ Returns Post record.
56
+
57
+ ### `votrix tools social posts results`
58
+
59
+ Read publication results.
60
+
61
+ ```text
62
+ votrix tools social posts results ID
63
+ ```
64
+
65
+ Returns Platform results.
66
+
67
+ ### `votrix tools social posts cancel`
68
+
69
+ Cancel a post.
70
+
71
+ ```text
72
+ votrix tools social posts cancel ID
73
+ ```
74
+
75
+ Returns Cancellation result.
76
+
77
+ ## Example
78
+
79
+ ```bash
80
+ votrix tools social accounts
81
+ votrix tools social posts create --account ACCOUNT_ID --caption "Launch day" --draft
82
+ votrix tools social posts get POST_ID
83
+ ```
84
+
85
+ Create returns posts with their IDs. Use results to retrieve publication outcomes.
package/docs/cli/ui.md ADDED
@@ -0,0 +1,45 @@
1
+ # UI tools
2
+
3
+ Discover design recipes and run one with the inputs returned by explore.
4
+
5
+ ## Commands
6
+
7
+ ### `votrix tools ui list`
8
+
9
+ Discover available tools.
10
+
11
+ ```text
12
+ votrix tools ui list
13
+ ```
14
+
15
+ Returns Current catalog.
16
+
17
+ ### `votrix tools ui explore`
18
+
19
+ Inspect supported parameters, outputs and price.
20
+
21
+ ```text
22
+ votrix tools ui explore NAME [--mode MODE]
23
+ ```
24
+
25
+ Returns Tool description and parameter schema.
26
+
27
+ ### `votrix tools ui run`
28
+
29
+ Run a tool. Explore its inputs first: explore shows credits at default settings. --max-credits refuses a run estimated above N credits, or one that cannot be priced. Waits by default.
30
+
31
+ ```text
32
+ votrix tools ui run NAME [--mode MODE] [--input JSON|@FILE] [--PARAM VALUE ...] [--max-credits N] [--out DIR] [--no-wait]
33
+ ```
34
+
35
+ Returns Run ID, status, estimate_credits, credits charged, and results or files.
36
+
37
+ ## Example
38
+
39
+ ```bash
40
+ votrix tools ui list
41
+ votrix tools ui explore design
42
+ votrix tools ui run design --site-type "bookshop" --story "choose a book" --out ./out
43
+ ```
44
+
45
+ Use the files array to locate generated outputs.
package/package.json CHANGED
@@ -1,6 +1,32 @@
1
1
  {
2
2
  "name": "@votrix-ai/cli",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.2.1",
4
+ "description": "Hand work to Votrix employees and run Votrix tools from a terminal or another agent.",
5
+ "license": "UNLICENSED",
6
+ "type": "module",
7
+ "bin": {
8
+ "votrix": "dist/src/cli.js"
9
+ },
10
+ "files": [
11
+ "dist/src/*.js",
12
+ "production.json",
13
+ "skills",
14
+ "README.md",
15
+ "SITE-TRACKING-CLI-DESIGN.md",
16
+ "docs"
17
+ ],
18
+ "engines": {
19
+ "node": ">=18.17"
20
+ },
21
+ "scripts": {
22
+ "build": "tsc -p tsconfig.json && node -e \"require('fs').chmodSync('dist/src/cli.js', 0o755)\"",
23
+ "test": "npm run build && node scripts/command-docs.mjs --check && node --test dist/test/*.test.js",
24
+ "prepare": "npm run build",
25
+ "prepublishOnly": "npm test",
26
+ "docs": "npm run build && node scripts/command-docs.mjs"
27
+ },
28
+ "devDependencies": {
29
+ "@types/node": "20.17.6",
30
+ "typescript": "5.6.3"
31
+ }
32
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "backend": "https://votrix-backend-eqp3ofm5eq-uk.a.run.app",
3
+ "auth": "https://auth.votrix.ai",
4
+ "public_key": "sb_publishable_K7skqbDUoncc0SQRRgoUZw_KYbWb01D"
5
+ }