@primitivedotdev/cli 0.31.3 → 0.31.5
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/dist/oclif/index.js +1507 -94
- package/man/primitive.1 +94 -0
- package/package.json +10 -3
package/man/primitive.1
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
.TH PRIMITIVE 1
|
|
2
|
+
.SH NAME
|
|
3
|
+
primitive \- command line interface for Primitive email and Functions
|
|
4
|
+
.SH SYNOPSIS
|
|
5
|
+
.B primitive
|
|
6
|
+
.I command
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.br
|
|
9
|
+
.B primitive
|
|
10
|
+
.B --help
|
|
11
|
+
.br
|
|
12
|
+
.B primitive
|
|
13
|
+
.I command
|
|
14
|
+
.B --help
|
|
15
|
+
.SH DESCRIPTION
|
|
16
|
+
.B primitive
|
|
17
|
+
is the command line interface for Primitive. It sends mail, inspects inbound and outbound email, manages domains and webhook endpoints, deploys Primitive Functions, and exposes generated API operations for scripting.
|
|
18
|
+
.PP
|
|
19
|
+
Most commands print human-readable output by default. Commands that expose JSON usually provide a
|
|
20
|
+
.B --json
|
|
21
|
+
flag or use generated operation output that can be piped into tools such as
|
|
22
|
+
.BR jq (1).
|
|
23
|
+
.SH AUTHENTICATION
|
|
24
|
+
Commands use saved OAuth credentials from
|
|
25
|
+
.B primitive signin
|
|
26
|
+
or an API key from
|
|
27
|
+
.B --api-key
|
|
28
|
+
or
|
|
29
|
+
.BR PRIMITIVE_API_KEY .
|
|
30
|
+
.PP
|
|
31
|
+
Run
|
|
32
|
+
.B primitive whoami
|
|
33
|
+
to verify which account the CLI is authenticated as.
|
|
34
|
+
.SH COMMON COMMANDS
|
|
35
|
+
.TP
|
|
36
|
+
.B primitive send --to ADDRESS --subject SUBJECT --body TEXT
|
|
37
|
+
Send an outbound email.
|
|
38
|
+
.TP
|
|
39
|
+
.B primitive send --to ADDRESS --body TEXT --attachment PATH
|
|
40
|
+
Send an outbound email with a file attachment.
|
|
41
|
+
.TP
|
|
42
|
+
.B primitive domains add DOMAIN
|
|
43
|
+
Start a custom-domain claim.
|
|
44
|
+
.TP
|
|
45
|
+
.B primitive domains verify --id DOMAIN_ID
|
|
46
|
+
Verify DNS records for a pending domain claim.
|
|
47
|
+
.TP
|
|
48
|
+
.B primitive domains zone-file --id DOMAIN_ID
|
|
49
|
+
Download DNS records as a BIND-format zone file.
|
|
50
|
+
.TP
|
|
51
|
+
.B primitive emails latest
|
|
52
|
+
Show recent inbound emails.
|
|
53
|
+
.TP
|
|
54
|
+
.B primitive functions init NAME
|
|
55
|
+
Scaffold a Primitive Function.
|
|
56
|
+
.TP
|
|
57
|
+
.B primitive functions deploy --name NAME --file PATH
|
|
58
|
+
Deploy a Primitive Function bundle.
|
|
59
|
+
.TP
|
|
60
|
+
.B primitive list-operations
|
|
61
|
+
Print the generated API operation manifest.
|
|
62
|
+
.TP
|
|
63
|
+
.B primitive describe COMMAND_OR_OPERATION
|
|
64
|
+
Describe a generated API operation, including request and response schemas.
|
|
65
|
+
.SH GLOBAL OPTIONS
|
|
66
|
+
.TP
|
|
67
|
+
.B --api-key KEY
|
|
68
|
+
Use an explicit Primitive API key for this command.
|
|
69
|
+
.TP
|
|
70
|
+
.B --time
|
|
71
|
+
Print command duration to standard error after completion.
|
|
72
|
+
.TP
|
|
73
|
+
.B --help
|
|
74
|
+
Show command help.
|
|
75
|
+
.SH ENVIRONMENT
|
|
76
|
+
.TP
|
|
77
|
+
.B PRIMITIVE_API_KEY
|
|
78
|
+
API key used when
|
|
79
|
+
.B --api-key
|
|
80
|
+
is not supplied and no saved OAuth credential should be used.
|
|
81
|
+
.TP
|
|
82
|
+
.B PRIMITIVE_API_BASE_URL_1
|
|
83
|
+
Override the primary API base URL. Intended for development and testing.
|
|
84
|
+
.TP
|
|
85
|
+
.B PRIMITIVE_API_BASE_URL_2
|
|
86
|
+
Override the secondary API base URL used for selected send flows. Intended for development and testing.
|
|
87
|
+
.SH FILES
|
|
88
|
+
.TP
|
|
89
|
+
.I ~/.config/primitive
|
|
90
|
+
Default CLI configuration directory used by oclif on most systems.
|
|
91
|
+
.SH SEE ALSO
|
|
92
|
+
.B primitive --help
|
|
93
|
+
.br
|
|
94
|
+
Primitive documentation: https://primitive.dev
|
package/package.json
CHANGED
|
@@ -1,16 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@primitivedotdev/cli",
|
|
3
|
-
"version": "0.31.
|
|
3
|
+
"version": "0.31.5",
|
|
4
4
|
"description": "Official Primitive CLI: deploy Primitive Functions, send and inspect mail, manage endpoints, all from the terminal. Wraps the @primitivedotdev/sdk runtime client with one-shot commands.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"sideEffects": false,
|
|
7
7
|
"files": [
|
|
8
8
|
"bin",
|
|
9
|
-
"dist"
|
|
9
|
+
"dist",
|
|
10
|
+
"man"
|
|
10
11
|
],
|
|
11
12
|
"bin": {
|
|
12
13
|
"primitive": "./bin/run.js"
|
|
13
14
|
},
|
|
15
|
+
"man": [
|
|
16
|
+
"./man/primitive.1"
|
|
17
|
+
],
|
|
14
18
|
"oclif": {
|
|
15
19
|
"bin": "primitive",
|
|
16
20
|
"commands": {
|
|
@@ -38,7 +42,10 @@
|
|
|
38
42
|
"description": "Agent signup and authentication API operations"
|
|
39
43
|
},
|
|
40
44
|
"domains": {
|
|
41
|
-
"description": "Claim, verify,
|
|
45
|
+
"description": "Claim, verify, manage email domains, and download DNS zone files"
|
|
46
|
+
},
|
|
47
|
+
"inbox": {
|
|
48
|
+
"description": "Check inbound email setup and processing readiness"
|
|
42
49
|
},
|
|
43
50
|
"emails": {
|
|
44
51
|
"description": "List, inspect, and wait for received emails. Prefer task aliases like `primitive emails list`, `primitive emails get`, `primitive emails latest`, `primitive emails wait`, and `primitive emails watch`; generated API names remain available for compatibility."
|