@simplepush/cli 0.1.0
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/LICENSE-APACHE +201 -0
- package/LICENSE-MIT +21 -0
- package/README.md +167 -0
- package/dist/main.mjs +3417 -0
- package/dist/main.mjs.map +1 -0
- package/package.json +64 -0
package/LICENSE-APACHE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Timm Schaeuble
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/LICENSE-MIT
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Timm Schaeuble
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
# @simplepush/cli
|
|
2
|
+
|
|
3
|
+
Command-line client for [Simplepush](https://simplepu.sh).
|
|
4
|
+
Binaries: `simplepush` and `sp` (alias).
|
|
5
|
+
|
|
6
|
+
## Install
|
|
7
|
+
|
|
8
|
+
```sh
|
|
9
|
+
bun add -g @simplepush/cli
|
|
10
|
+
# or
|
|
11
|
+
npm install -g @simplepush/cli
|
|
12
|
+
# or run without installing
|
|
13
|
+
bunx @simplepush/cli events --since 24h
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Commands
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
sp task Send a task, optionally wait for the first completion.
|
|
20
|
+
sp subtask Append a follow-up to an existing task via its append token.
|
|
21
|
+
sp notify Send a fire-and-forget notification.
|
|
22
|
+
sp collect Collect replies, inputs, or submissions as bounded NDJSON.
|
|
23
|
+
sp download Download one file a collect line referenced, by its ids.
|
|
24
|
+
sp events Stream or replay the raw event feed.
|
|
25
|
+
sp auth Log in to an organization (login / logout / status).
|
|
26
|
+
sp org Administer an organization: members, invites, topics, API key, encryption.
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Two credentials, picked automatically: your personal API token (from the app settings, via `--api-token` or `$SP_API_TOKEN`) for personal sends and `sp events`, and an organization session (`sp auth login`) for org sends, org-wide collects and downloads, and `sp org`.
|
|
30
|
+
|
|
31
|
+
## Examples
|
|
32
|
+
|
|
33
|
+
### Ask a question from a script, block until it is answered
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
sp task -t ops --title "Deploy v2.1.0 to prod?" \
|
|
37
|
+
-a "approve=Approve:primary,abort=Abort:destructive" \
|
|
38
|
+
--wait
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
`--wait` blocks until the recipient taps a button on their phone and prints the result. This turns any shell script into something that can stop and ask a human.
|
|
42
|
+
|
|
43
|
+
### Collect structured answers from real people
|
|
44
|
+
|
|
45
|
+
Tasks carry typed inputs: text, single or multi choice, action buttons, sliders, photo, voice recording, file upload, and GPS location.
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
sp task -t field-crew --title "Morning site check" \
|
|
49
|
+
--photo-input "Photo of the meter" \
|
|
50
|
+
--slider-input "Water temperature;min=0;max=40;step=0.5;unit=C" \
|
|
51
|
+
--choice-input "Which pumps are running?;P1,P2,P3;multi=true" \
|
|
52
|
+
--text-input "Anything unusual?;required=false"
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Pipe a send into `sp collect` and get NDJSON back
|
|
56
|
+
|
|
57
|
+
`--format json` prints a machine-readable `sent` line that `sp collect` consumes. Every answer then arrives as one JSON line, and a final `end` line tells you why the stream stopped. Built for scripts and agents.
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
sp task -b --format json --title "Standup" \
|
|
61
|
+
--text-input "What did you ship today?" \
|
|
62
|
+
| sp collect --inputs > answers.ndjson
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Notifications work the same way when they carry an input:
|
|
66
|
+
|
|
67
|
+
```sh
|
|
68
|
+
sp notify -t ops --content "Restart the staging cluster?" -c "Approve,Deny" \
|
|
69
|
+
--format json | sp collect
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Download the files people upload
|
|
73
|
+
|
|
74
|
+
`--save-files` downloads every collected file (photos, voice recordings, file uploads, reply and submission files) into a directory as it streams in, decrypted and checksum-verified. Each file object on the NDJSON line gains a `path` with the saved location.
|
|
75
|
+
|
|
76
|
+
```sh
|
|
77
|
+
sp task -b --format json --title "Site check" --photo-input "Photo of the meter" \
|
|
78
|
+
| sp collect --inputs --save-files ./meter-photos
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
`sp download` fetches a single file after the fact, using the ids a collect line carried (`taskId` + the upload's `id`, or a submission's `id` + its file's `id`):
|
|
82
|
+
|
|
83
|
+
```sh
|
|
84
|
+
sp download tsk_0198… inp_0198… # task input upload or rfl_… reply file
|
|
85
|
+
sp download sbm_0198… sbf_0198… --out . # submission file
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
It searches the last 7 days of your event stream for the file's metadata; pass `--since 90d` for older files.
|
|
89
|
+
|
|
90
|
+
### Capture submissions from your phone
|
|
91
|
+
|
|
92
|
+
A submission is content you push from the app with no task attached: a note, a photo, a file, a voice memo, a location. `sp collect --submissions` streams your inbox as NDJSON, one line per submission, and watches until Ctrl-C:
|
|
93
|
+
|
|
94
|
+
```sh
|
|
95
|
+
sp collect --submissions --save-files ./inbox -p "account-password"
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
Attachments land in `./inbox`; the bare `-p` password is your account default and decrypts encrypted submissions. `--since 7d` backfills earlier submissions first.
|
|
99
|
+
|
|
100
|
+
### Send to your own devices
|
|
101
|
+
|
|
102
|
+
Omit the target entirely and the send goes to all of your own devices.
|
|
103
|
+
|
|
104
|
+
```sh
|
|
105
|
+
sp task --title "Pick up the package" --content "Locker 14, code 8841"
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### End-to-end encrypt
|
|
109
|
+
|
|
110
|
+
`password@topic` encrypts everything sent to that topic on your machine; the same flag decrypts on receive. The server never sees plaintext.
|
|
111
|
+
|
|
112
|
+
```sh
|
|
113
|
+
sp task -t alerts -p "hunter2@alerts" --title "Rotate the door code" \
|
|
114
|
+
--text-input "New code?"
|
|
115
|
+
|
|
116
|
+
sp events -t alerts --since 24h -p "hunter2@alerts"
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Attach files and render Markdown
|
|
120
|
+
|
|
121
|
+
```sh
|
|
122
|
+
sp task -t design --markdown -f mock.png \
|
|
123
|
+
--title "Design review" \
|
|
124
|
+
--content "Check the **hero section**, then vote:" \
|
|
125
|
+
-c "Ship it,Iterate"
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Files are uploaded (and encrypted when the send is), `--link` attaches URLs instead.
|
|
129
|
+
|
|
130
|
+
### Append follow-ups to a running task
|
|
131
|
+
|
|
132
|
+
Every send prints an append token. `sp subtask` uses it to push another step onto the task the recipient already has, with the full input palette available.
|
|
133
|
+
|
|
134
|
+
```sh
|
|
135
|
+
sp subtask --append-token "$TOKEN" \
|
|
136
|
+
--content "One more approval needed" \
|
|
137
|
+
-a "accept=Accept:primary,deny=Deny:destructive"
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Watch your account live, or replay history
|
|
141
|
+
|
|
142
|
+
```sh
|
|
143
|
+
sp events # live firehose
|
|
144
|
+
sp events --since 7d --type submission --format pretty
|
|
145
|
+
sp collect --submissions --until count:1 # block until the next inbox submission
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Run an organization from the terminal
|
|
149
|
+
|
|
150
|
+
```sh
|
|
151
|
+
sp auth login # browser or device-code flow
|
|
152
|
+
sp org members invite "Alice" # prints a one-time login code for her app
|
|
153
|
+
sp notify -b --title "All hands at 3pm" --content "Room 2"
|
|
154
|
+
sp task -m "Alice" --title "Badge photo" --photo-input "A selfie please"
|
|
155
|
+
sp org encryption enable # end-to-end encryption for the whole org
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
Run `sp <command> --help` for every flag, or see the [full CLI guide](https://simplepu.sh/guide/cli-tool).
|
|
159
|
+
|
|
160
|
+
## Building a standalone binary
|
|
161
|
+
|
|
162
|
+
Bun can compile the CLI into a single-file native binary:
|
|
163
|
+
|
|
164
|
+
```sh
|
|
165
|
+
bun run build:binary
|
|
166
|
+
./bin/simplepush --help
|
|
167
|
+
```
|