pterm 0.0.8 → 0.0.10
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 +26 -26
- package/package.json +2 -2
- package/util.js +1 -0
package/README.md
CHANGED
|
@@ -17,7 +17,7 @@ prints the current version
|
|
|
17
17
|
### syntax
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
|
|
20
|
+
pterm version <type>
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
- `type`: may be `terminal`, `pinokiod`, or `pinokio`
|
|
@@ -28,7 +28,7 @@ pinokio version <type>
|
|
|
28
28
|
### example
|
|
29
29
|
|
|
30
30
|
```
|
|
31
|
-
|
|
31
|
+
pterm version terminal
|
|
32
32
|
```
|
|
33
33
|
|
|
34
34
|
## start
|
|
@@ -38,7 +38,7 @@ Start a pinokio script. Arguments can be passed into the script
|
|
|
38
38
|
### syntax
|
|
39
39
|
|
|
40
40
|
```
|
|
41
|
-
|
|
41
|
+
pterm start <script_path> [<arg1>, <arg2>, ...]
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
### examples
|
|
@@ -46,13 +46,13 @@ pinokio start <script_path> [<arg1>, <arg2>, ...]
|
|
|
46
46
|
Starting a script named `install.js`:
|
|
47
47
|
|
|
48
48
|
```
|
|
49
|
-
|
|
49
|
+
pterm start install.js
|
|
50
50
|
```
|
|
51
51
|
|
|
52
52
|
Starting a script named `start.js` with parameters:
|
|
53
53
|
|
|
54
54
|
```
|
|
55
|
-
|
|
55
|
+
pterm start start.js --port=3000 --model=google/gemma-3n-E4B-it
|
|
56
56
|
```
|
|
57
57
|
|
|
58
58
|
Above command starts the script `start.js` with the following args:
|
|
@@ -88,7 +88,7 @@ Stops a script if running:
|
|
|
88
88
|
### syntax
|
|
89
89
|
|
|
90
90
|
```
|
|
91
|
-
|
|
91
|
+
pterm stop <script_path>
|
|
92
92
|
```
|
|
93
93
|
|
|
94
94
|
|
|
@@ -97,7 +97,7 @@ pinokio stop <script_path>
|
|
|
97
97
|
Stop the `start.js` script if it's running:
|
|
98
98
|
|
|
99
99
|
```
|
|
100
|
-
|
|
100
|
+
pterm stop start.js
|
|
101
101
|
```
|
|
102
102
|
|
|
103
103
|
## run
|
|
@@ -107,7 +107,7 @@ Run a launcher. Equivalent to the user visiting a launcher page. Will run whiche
|
|
|
107
107
|
### syntax
|
|
108
108
|
|
|
109
109
|
```
|
|
110
|
-
|
|
110
|
+
pterm run <launcher_path>
|
|
111
111
|
```
|
|
112
112
|
|
|
113
113
|
### examples
|
|
@@ -115,13 +115,13 @@ pinokio run <launcher_path>
|
|
|
115
115
|
Launch the launcher in the current path
|
|
116
116
|
|
|
117
117
|
```
|
|
118
|
-
|
|
118
|
+
pterm run .
|
|
119
119
|
```
|
|
120
120
|
|
|
121
121
|
Launch from absolute path
|
|
122
122
|
|
|
123
123
|
```
|
|
124
|
-
|
|
124
|
+
pterm run /pinokio/api/test
|
|
125
125
|
```
|
|
126
126
|
|
|
127
127
|
## filepicker
|
|
@@ -133,7 +133,7 @@ This API is NOT for uploading the actual files but for submitting file paths.
|
|
|
133
133
|
### syntax
|
|
134
134
|
|
|
135
135
|
```
|
|
136
|
-
|
|
136
|
+
pterm filepicker [<arg>, <arg>, ...]
|
|
137
137
|
```
|
|
138
138
|
|
|
139
139
|
Where args can be one of the following:
|
|
@@ -150,7 +150,7 @@ Where args can be one of the following:
|
|
|
150
150
|
#### Select a folder path
|
|
151
151
|
|
|
152
152
|
```
|
|
153
|
-
|
|
153
|
+
pterm filepicker --type=folder
|
|
154
154
|
```
|
|
155
155
|
|
|
156
156
|
#### Select a file path
|
|
@@ -158,37 +158,37 @@ pinokio filepicker --type=folder
|
|
|
158
158
|
The most basic command lets users select a single file:
|
|
159
159
|
|
|
160
160
|
```
|
|
161
|
-
|
|
161
|
+
pterm filepicker
|
|
162
162
|
```
|
|
163
163
|
|
|
164
164
|
which is equivalent to:
|
|
165
165
|
|
|
166
166
|
```
|
|
167
|
-
|
|
167
|
+
pterm filepicker --type=file
|
|
168
168
|
```
|
|
169
169
|
|
|
170
170
|
#### Select multiple files
|
|
171
171
|
|
|
172
172
|
```
|
|
173
|
-
|
|
173
|
+
pterm filepicker --multiple
|
|
174
174
|
```
|
|
175
175
|
|
|
176
176
|
#### Open the filepicker from the current path
|
|
177
177
|
|
|
178
178
|
```
|
|
179
|
-
|
|
179
|
+
pterm filepicker --path=.
|
|
180
180
|
```
|
|
181
181
|
|
|
182
182
|
#### Open an image filepicker
|
|
183
183
|
|
|
184
184
|
```
|
|
185
|
-
|
|
185
|
+
pterm filepicker --filetype='images/*.png,*.jpg,*.jpeg'
|
|
186
186
|
```
|
|
187
187
|
|
|
188
188
|
#### Open a filepicker with multiple file types
|
|
189
189
|
|
|
190
190
|
```
|
|
191
|
-
|
|
191
|
+
pterm filepicker --filetype='images/*.png,*.jpg,*.jpeg' --filetype='docs/*.pdf'
|
|
192
192
|
```
|
|
193
193
|
|
|
194
194
|
## clipboard
|
|
@@ -198,8 +198,8 @@ write to or read from clipboard
|
|
|
198
198
|
### syntax
|
|
199
199
|
|
|
200
200
|
```
|
|
201
|
-
|
|
202
|
-
|
|
201
|
+
pterm clipboard copy <text>
|
|
202
|
+
pterm clipboard paste
|
|
203
203
|
```
|
|
204
204
|
|
|
205
205
|
|
|
@@ -210,7 +210,7 @@ pinokio clipboard paste
|
|
|
210
210
|
The following command copies "hello world" to the clipboard
|
|
211
211
|
|
|
212
212
|
```
|
|
213
|
-
|
|
213
|
+
pterm clipboard copy "hello world"
|
|
214
214
|
```
|
|
215
215
|
|
|
216
216
|
#### read from clipboard
|
|
@@ -218,7 +218,7 @@ pinokio clipboard copy "hello world"
|
|
|
218
218
|
Assuming the clipboard contains the text 'hello world',
|
|
219
219
|
|
|
220
220
|
```
|
|
221
|
-
|
|
221
|
+
pterm clipboard paste
|
|
222
222
|
```
|
|
223
223
|
|
|
224
224
|
will print:
|
|
@@ -236,7 +236,7 @@ Send a desktop notification
|
|
|
236
236
|
### syntax
|
|
237
237
|
|
|
238
238
|
```
|
|
239
|
-
|
|
239
|
+
pterm push <message> [<arg>, <arg>, ...]
|
|
240
240
|
```
|
|
241
241
|
|
|
242
242
|
- `message`: a message to send
|
|
@@ -253,18 +253,18 @@ pinokio push <message> [<arg>, <arg>, ...]
|
|
|
253
253
|
#### send a simple notification
|
|
254
254
|
|
|
255
255
|
```
|
|
256
|
-
|
|
256
|
+
pterm push 'hello world'
|
|
257
257
|
```
|
|
258
258
|
|
|
259
259
|
#### notification with sound
|
|
260
260
|
|
|
261
261
|
```
|
|
262
|
-
|
|
262
|
+
pterm push 'this is a notification' --sound
|
|
263
263
|
```
|
|
264
264
|
|
|
265
265
|
#### notification with an image
|
|
266
266
|
|
|
267
267
|
```
|
|
268
|
-
|
|
268
|
+
pterm push 'this is an image notification' --image=icon.png
|
|
269
269
|
```
|
|
270
270
|
|
package/package.json
CHANGED