@signaliz/cli 1.0.62 → 1.0.64
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 +45 -24
- package/dist/bin.js +707 -269
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# @signaliz/cli
|
|
2
2
|
|
|
3
|
-
The Signaliz CLI exposes all five core products
|
|
3
|
+
The Signaliz CLI exposes all five core products, plus Signal Awareness and
|
|
4
|
+
Signaliz Flow through the same public contract:
|
|
4
5
|
|
|
5
6
|
```bash
|
|
6
7
|
npm install -g @signaliz/cli
|
|
@@ -12,30 +13,36 @@ signaliz auth login
|
|
|
12
13
|
# https://api.signaliz.com/functions/v1/api/v1/company-signals
|
|
13
14
|
# https://api.signaliz.com/functions/v1/api/v1/signal-to-copy
|
|
14
15
|
# https://api.signaliz.com/functions/v1/api/v1/signals
|
|
16
|
+
# https://api.signaliz.com/functions/v1/api/v1/signal-awareness
|
|
17
|
+
# https://api.signaliz.com/functions/v1/api/v1/flow
|
|
18
|
+
# The same contracts are available under /api/v2/.
|
|
15
19
|
|
|
16
20
|
signaliz find-email --company-domain example.com --full-name "Jane Doe"
|
|
17
21
|
# An HTTPS LinkedIn person profile URL (/in/<slug>) is sufficient without a name or company domain
|
|
18
22
|
signaliz find-email --linkedin-url "https://www.linkedin.com/in/jane-doe"
|
|
19
|
-
# Force a fresh-provider quality check instead of reusing cached email or verification data
|
|
20
|
-
signaliz find-email --company-domain example.com --full-name "Jane Doe" --skip-cache
|
|
21
23
|
signaliz verify-email jane@example.com
|
|
22
|
-
# Force a fresh-provider verification instead of reusing cached proof
|
|
23
|
-
signaliz verify-email jane@example.com --skip-cache
|
|
24
24
|
# Preview any single or batch product request without provider calls or credits
|
|
25
25
|
signaliz verify-email jane@example.com --dry-run --json
|
|
26
26
|
# Return early when a provider check runs long, then resume the exact run
|
|
27
|
-
signaliz verify-email jane@example.com --
|
|
27
|
+
signaliz verify-email jane@example.com --no-wait --json
|
|
28
28
|
signaliz verify-email --verification-run-id run_... --json
|
|
29
29
|
signaliz company-signals --domain example.com --research-prompt "expansion priorities"
|
|
30
|
+
signaliz company-signals --domain example.com --research-prompt "expansion priorities"
|
|
30
31
|
signaliz signal-to-copy \
|
|
31
32
|
--company-domain example.com \
|
|
32
33
|
--person-name "Jane Doe" \
|
|
33
34
|
--title "VP Sales" \
|
|
34
35
|
--campaign-offer "pipeline intelligence"
|
|
35
36
|
|
|
36
|
-
#
|
|
37
|
+
# Reuse the exact Signals First snapshot, fact, or event instead of rediscovering it.
|
|
38
|
+
# Keep company/recipient/offer fields so Signaliz can validate identity and write the copy.
|
|
39
|
+
signaliz signal-to-copy --fact-id <64-character-sha256> \
|
|
40
|
+
--company-domain example.com --person-name "Jane Doe" \
|
|
41
|
+
--title "VP Sales" --campaign-offer "pipeline intelligence"
|
|
42
|
+
|
|
43
|
+
# Opt into slower deep research when needed
|
|
37
44
|
signaliz signal-to-copy --company-domain example.com --person-name "Jane Doe" \
|
|
38
|
-
--title "VP Sales" --campaign-offer "pipeline intelligence" --
|
|
45
|
+
--title "VP Sales" --campaign-offer "pipeline intelligence" --deep-search
|
|
39
46
|
|
|
40
47
|
# Omit --deep-search for bounded credit-free first-party and Bing grounding.
|
|
41
48
|
|
|
@@ -46,6 +53,16 @@ signaliz signals "companies showing signals they need account-signal automation"
|
|
|
46
53
|
--icp-context "B2B SaaS with outbound teams and manual account research" \
|
|
47
54
|
--limit 100 --sources web,news
|
|
48
55
|
signaliz signals --signal-search-run-id run_... --wait --json
|
|
56
|
+
|
|
57
|
+
# Monitor companies and retrieve seven-field verified signal rows
|
|
58
|
+
# reason and replacement pointers forward.
|
|
59
|
+
signaliz awareness list --limit 100 --offset 0 --json
|
|
60
|
+
signaliz awareness signals --monitor-id <uuid> --limit 100 --offset 0 --json
|
|
61
|
+
|
|
62
|
+
# Flow starts and resumes through the versioned REST contract.
|
|
63
|
+
signaliz flow --signal-query "companies with recent hiring" \
|
|
64
|
+
--campaign-offer "pipeline intelligence"
|
|
65
|
+
signaliz flow --run-id run_... --json
|
|
49
66
|
```
|
|
50
67
|
|
|
51
68
|
Use `--json` with any product command for structured output.
|
|
@@ -66,6 +83,14 @@ signaliz signal-to-copy --input copy-requests.jsonl --no-wait --json
|
|
|
66
83
|
signaliz signal-to-copy --job-id job_... --idempotency-key key_... --json
|
|
67
84
|
```
|
|
68
85
|
|
|
86
|
+
Signal to Copy accepts `signal_search_run_id`, `fact_id`, or `event_id` in
|
|
87
|
+
JSON/JSONL rows, and the equivalent `--signal-search-run-id`, `--fact-id`, or
|
|
88
|
+
`--event-id` flags for one request. These references reuse canonical evidence
|
|
89
|
+
in single calls and synchronous batches of at most 25. Durable batches of
|
|
90
|
+
26-5,000 reject canonical references instead of silently rediscovering them.
|
|
91
|
+
JSON output exposes the normalized customer-facing signal fields; human output
|
|
92
|
+
prints the signal type, verified source URL, date, company name, and domain.
|
|
93
|
+
|
|
69
94
|
Retrieve completed Company/Copy result pages within seven days. If retention
|
|
70
95
|
expires, the CLI returns non-retryable `BATCH_RESULTS_EXPIRED`; do not
|
|
71
96
|
automatically rerun the submission because provider work may already have been
|
|
@@ -118,31 +143,27 @@ recoverable REST job for inputs larger than 25; the CLI waits by default or
|
|
|
118
143
|
returns `job_id`, `idempotency_key`, and an exact resume command with
|
|
119
144
|
`--no-wait`. Find Email, Verify Email, and Company Signal Enrichment use 25-row
|
|
120
145
|
pages; Signal to Copy uses 100-row pages. Large Find Email and Verify Email
|
|
121
|
-
batches honor `--max-wait-ms` and `--poll-interval-ms`. Durable Signal to Copy jobs
|
|
122
|
-
|
|
123
|
-
deep
|
|
124
|
-
idempotency, or synchronous-only controls fail locally before HTTP; split those
|
|
125
|
-
requests into batches of at most 25. Company Signal `signal_run_id` recovery
|
|
146
|
+
batches honor `--max-wait-ms` and `--poll-interval-ms`. Durable Signal to Copy jobs
|
|
147
|
+
complete missing company-signal research before generating copy and accept
|
|
148
|
+
uniform `--deep-search` controls. Company Signal `signal_run_id` recovery
|
|
126
149
|
rows likewise stay in direct batches of at most 25. Large Company Signal jobs
|
|
127
150
|
persist bounded result pages and exclude rejected candidate-evidence
|
|
128
151
|
diagnostics; use `--include-candidate-evidence` only with batches of at most 25.
|
|
129
152
|
|
|
130
|
-
Every command uses the authenticated workspace. Find Email
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
Agency, and Pay-As-You-Go include
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
`--lookback-days` remains a hard evidence-age bound for both
|
|
138
|
-
cached and fresh Company Signals and Signal to Copy results.
|
|
153
|
+
Every command uses the authenticated workspace. Find Email costs 1 credit per
|
|
154
|
+
returned result and Verify Email costs 0.02 credits per returned terminal result
|
|
155
|
+
on every plan. Signaliz automatically reuses eligible evidence and prevents
|
|
156
|
+
duplicate provider work. Builder, Team, Agency, and Pay-As-You-Go include
|
|
157
|
+
Company Signals. Signal to Copy costs 1 credit per successful result on Free and
|
|
158
|
+
Builder, and is unlimited on Team and Agency. `--lookback-days` remains a hard
|
|
159
|
+
evidence-age bound.
|
|
139
160
|
|
|
140
161
|
Signals Everything is a query-first company discovery command rather than a
|
|
141
162
|
row batch. It returns only dated, source-linked signals that contain both a
|
|
142
163
|
company name and company domain. The default request is 100 companies and the
|
|
143
164
|
maximum is 1,000. It is included on Builder, Team, and Agency plans, is resumable with
|
|
144
|
-
`signal_search_run_id`, and reports
|
|
145
|
-
|
|
165
|
+
`signal_search_run_id`, and reports measured source cost plus target warnings
|
|
166
|
+
without rejecting a valid run solely on a projected preflight estimate. A request
|
|
146
167
|
is a ceiling, not a promise: it can return fewer results when public evidence
|
|
147
168
|
cannot verify both a date and company identity. Use `--icp-context` to qualify
|
|
148
169
|
an open-ended signal request against a target market.
|