@xano/cli 0.0.4 → 0.0.6
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 +89 -1153
- package/oclif.manifest.json +563 -563
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,1200 +1,136 @@
|
|
|
1
|
-
|
|
2
|
-
=================
|
|
1
|
+
# Xano CLI
|
|
3
2
|
|
|
4
|
-
|
|
3
|
+
Command-line interface for the Xano Metadata API.
|
|
5
4
|
|
|
5
|
+
[](https://npmjs.org/package/@xano/cli)
|
|
6
|
+
[](https://npmjs.org/package/@xano/cli)
|
|
6
7
|
|
|
7
|
-
|
|
8
|
-
[](https://npmjs.org/package/xano)
|
|
9
|
-
[](https://npmjs.org/package/xano)
|
|
8
|
+
## Installation
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
* [Usage](#usage)
|
|
14
|
-
* [Commands](#commands)
|
|
15
|
-
<!-- tocstop -->
|
|
16
|
-
# Usage
|
|
17
|
-
<!-- usage -->
|
|
18
|
-
```sh-session
|
|
19
|
-
$ npm install -g @xano/cli
|
|
20
|
-
$ xano COMMAND
|
|
21
|
-
running command...
|
|
22
|
-
$ xano (--version)
|
|
23
|
-
@xano/cli/0.0.4 darwin-arm64 node-v22.19.0
|
|
24
|
-
$ xano --help [COMMAND]
|
|
25
|
-
USAGE
|
|
26
|
-
$ xano COMMAND
|
|
27
|
-
...
|
|
28
|
-
```
|
|
29
|
-
<!-- usagestop -->
|
|
30
|
-
# Commands
|
|
31
|
-
<!-- commands -->
|
|
32
|
-
* [`xano ephemeral run job`](#xano-ephemeral-run-job)
|
|
33
|
-
* [`xano ephemeral run service`](#xano-ephemeral-run-service)
|
|
34
|
-
* [`xano function create`](#xano-function-create)
|
|
35
|
-
* [`xano function edit [FUNCTION_ID]`](#xano-function-edit-function_id)
|
|
36
|
-
* [`xano function get [FUNCTION_ID]`](#xano-function-get-function_id)
|
|
37
|
-
* [`xano function list`](#xano-function-list)
|
|
38
|
-
* [`xano help [COMMAND]`](#xano-help-command)
|
|
39
|
-
* [`xano plugins`](#xano-plugins)
|
|
40
|
-
* [`xano plugins add PLUGIN`](#xano-plugins-add-plugin)
|
|
41
|
-
* [`xano plugins:inspect PLUGIN...`](#xano-pluginsinspect-plugin)
|
|
42
|
-
* [`xano plugins install PLUGIN`](#xano-plugins-install-plugin)
|
|
43
|
-
* [`xano plugins link PATH`](#xano-plugins-link-path)
|
|
44
|
-
* [`xano plugins remove [PLUGIN]`](#xano-plugins-remove-plugin)
|
|
45
|
-
* [`xano plugins reset`](#xano-plugins-reset)
|
|
46
|
-
* [`xano plugins uninstall [PLUGIN]`](#xano-plugins-uninstall-plugin)
|
|
47
|
-
* [`xano plugins unlink [PLUGIN]`](#xano-plugins-unlink-plugin)
|
|
48
|
-
* [`xano plugins update`](#xano-plugins-update)
|
|
49
|
-
* [`xano profile create NAME`](#xano-profile-create-name)
|
|
50
|
-
* [`xano profile delete NAME`](#xano-profile-delete-name)
|
|
51
|
-
* [`xano profile edit NAME`](#xano-profile-edit-name)
|
|
52
|
-
* [`xano profile get-default`](#xano-profile-get-default)
|
|
53
|
-
* [`xano profile list`](#xano-profile-list)
|
|
54
|
-
* [`xano profile set-default NAME`](#xano-profile-set-default-name)
|
|
55
|
-
* [`xano profile wizard`](#xano-profile-wizard)
|
|
56
|
-
* [`xano static_host build create STATIC_HOST`](#xano-static_host-build-create-static_host)
|
|
57
|
-
* [`xano static_host build get STATIC_HOST BUILD_ID`](#xano-static_host-build-get-static_host-build_id)
|
|
58
|
-
* [`xano static_host build list STATIC_HOST`](#xano-static_host-build-list-static_host)
|
|
59
|
-
* [`xano static_host list`](#xano-static_host-list)
|
|
60
|
-
* [`xano workspace list`](#xano-workspace-list)
|
|
61
|
-
|
|
62
|
-
## `xano ephemeral run job`
|
|
63
|
-
|
|
64
|
-
Run an ephemeral job in a workspace
|
|
65
|
-
|
|
66
|
-
```
|
|
67
|
-
USAGE
|
|
68
|
-
$ xano ephemeral run job [-p <value>] [-w <value>] [-e [-f <value> | -s]] [-o summary|json] [-a <value>]
|
|
69
|
-
|
|
70
|
-
FLAGS
|
|
71
|
-
-a, --args=<value> Path to JSON file containing input arguments
|
|
72
|
-
-e, --edit Open file in editor before running job (requires --file)
|
|
73
|
-
-f, --file=<value> Path to file containing XanoScript code
|
|
74
|
-
-o, --output=<option> [default: summary] Output format
|
|
75
|
-
<options: summary|json>
|
|
76
|
-
-p, --profile=<value> [env: XANO_PROFILE] Profile to use for this command
|
|
77
|
-
-s, --stdin Read XanoScript code from stdin
|
|
78
|
-
-w, --workspace=<value> Workspace ID (optional if set in profile)
|
|
79
|
-
|
|
80
|
-
DESCRIPTION
|
|
81
|
-
Run an ephemeral job in a workspace
|
|
82
|
-
|
|
83
|
-
EXAMPLES
|
|
84
|
-
$ xano ephemeral:run:job -w 1 -f script.xs
|
|
85
|
-
Job executed successfully!
|
|
86
|
-
...
|
|
87
|
-
|
|
88
|
-
$ xano ephemeral:run:job -f script.xs
|
|
89
|
-
Job executed successfully!
|
|
90
|
-
...
|
|
91
|
-
|
|
92
|
-
$ xano ephemeral:run:job -w 1 -f script.xs --edit
|
|
93
|
-
# Opens script.xs in $EDITOR, then runs job with edited content
|
|
94
|
-
Job executed successfully!
|
|
95
|
-
...
|
|
96
|
-
|
|
97
|
-
$ cat script.xs | xano ephemeral:run:job -w 1 --stdin
|
|
98
|
-
Job executed successfully!
|
|
99
|
-
...
|
|
100
|
-
|
|
101
|
-
$ xano ephemeral:run:job -w 1 -f script.xs -o json
|
|
102
|
-
{
|
|
103
|
-
"job": { "id": 1, "run": { "id": 1 } },
|
|
104
|
-
"result": { ... }
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
$ xano ephemeral:run:job -w 1 -f script.xs -a args.json
|
|
108
|
-
# Runs job with input arguments from args.json
|
|
109
|
-
Job executed successfully!
|
|
110
|
-
...
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
_See code: [src/commands/ephemeral/run/job/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/ephemeral/run/job/index.ts)_
|
|
114
|
-
|
|
115
|
-
## `xano ephemeral run service`
|
|
116
|
-
|
|
117
|
-
Run an ephemeral service in a workspace
|
|
118
|
-
|
|
119
|
-
```
|
|
120
|
-
USAGE
|
|
121
|
-
$ xano ephemeral run service [-p <value>] [-w <value>] [-e [-f <value> | -s]] [-o summary|json]
|
|
122
|
-
|
|
123
|
-
FLAGS
|
|
124
|
-
-e, --edit Open file in editor before running service (requires --file)
|
|
125
|
-
-f, --file=<value> Path to file containing XanoScript code
|
|
126
|
-
-o, --output=<option> [default: summary] Output format
|
|
127
|
-
<options: summary|json>
|
|
128
|
-
-p, --profile=<value> [env: XANO_PROFILE] Profile to use for this command
|
|
129
|
-
-s, --stdin Read XanoScript code from stdin
|
|
130
|
-
-w, --workspace=<value> Workspace ID (optional if set in profile)
|
|
131
|
-
|
|
132
|
-
DESCRIPTION
|
|
133
|
-
Run an ephemeral service in a workspace
|
|
134
|
-
|
|
135
|
-
EXAMPLES
|
|
136
|
-
$ xano ephemeral:run:service -w 1 -f service.xs
|
|
137
|
-
Service created successfully!
|
|
138
|
-
...
|
|
139
|
-
|
|
140
|
-
$ xano ephemeral:run:service -f service.xs
|
|
141
|
-
Service created successfully!
|
|
142
|
-
...
|
|
143
|
-
|
|
144
|
-
$ xano ephemeral:run:service -w 1 -f service.xs --edit
|
|
145
|
-
# Opens service.xs in $EDITOR, then creates service with edited content
|
|
146
|
-
Service created successfully!
|
|
147
|
-
...
|
|
148
|
-
|
|
149
|
-
$ cat service.xs | xano ephemeral:run:service -w 1 --stdin
|
|
150
|
-
Service created successfully!
|
|
151
|
-
...
|
|
152
|
-
|
|
153
|
-
$ xano ephemeral:run:service -w 1 -f service.xs -o json
|
|
154
|
-
{
|
|
155
|
-
"service": { "id": 1 },
|
|
156
|
-
...
|
|
157
|
-
}
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
_See code: [src/commands/ephemeral/run/service/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/ephemeral/run/service/index.ts)_
|
|
161
|
-
|
|
162
|
-
## `xano function create`
|
|
163
|
-
|
|
164
|
-
Create a new function in a workspace
|
|
165
|
-
|
|
166
|
-
```
|
|
167
|
-
USAGE
|
|
168
|
-
$ xano function create [-p <value>] [-w <value>] [-e [-f <value> | -s]] [-o summary|json]
|
|
169
|
-
|
|
170
|
-
FLAGS
|
|
171
|
-
-e, --edit Open file in editor before creating function (requires --file)
|
|
172
|
-
-f, --file=<value> Path to file containing XanoScript code
|
|
173
|
-
-o, --output=<option> [default: summary] Output format
|
|
174
|
-
<options: summary|json>
|
|
175
|
-
-p, --profile=<value> [env: XANO_PROFILE] Profile to use for this command
|
|
176
|
-
-s, --stdin Read XanoScript code from stdin
|
|
177
|
-
-w, --workspace=<value> Workspace ID (optional if set in profile)
|
|
178
|
-
|
|
179
|
-
DESCRIPTION
|
|
180
|
-
Create a new function in a workspace
|
|
181
|
-
|
|
182
|
-
EXAMPLES
|
|
183
|
-
$ xano function:create -w 40 -f function.xs
|
|
184
|
-
Function created successfully!
|
|
185
|
-
ID: 123
|
|
186
|
-
Name: my_function
|
|
187
|
-
|
|
188
|
-
$ xano function:create -f function.xs
|
|
189
|
-
Function created successfully!
|
|
190
|
-
ID: 123
|
|
191
|
-
Name: my_function
|
|
192
|
-
|
|
193
|
-
$ xano function:create -w 40 -f function.xs --edit
|
|
194
|
-
# Opens function.xs in $EDITOR, then creates function with edited content
|
|
195
|
-
Function created successfully!
|
|
196
|
-
ID: 123
|
|
197
|
-
Name: my_function
|
|
198
|
-
|
|
199
|
-
$ cat function.xs | xano function:create -w 40 --stdin
|
|
200
|
-
Function created successfully!
|
|
201
|
-
ID: 123
|
|
202
|
-
Name: my_function
|
|
203
|
-
|
|
204
|
-
$ xano function:create -w 40 -f function.xs -o json
|
|
205
|
-
{
|
|
206
|
-
"id": 123,
|
|
207
|
-
"name": "my_function",
|
|
208
|
-
...
|
|
209
|
-
}
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
_See code: [src/commands/function/create/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/function/create/index.ts)_
|
|
213
|
-
|
|
214
|
-
## `xano function edit [FUNCTION_ID]`
|
|
215
|
-
|
|
216
|
-
Edit a function in a workspace
|
|
217
|
-
|
|
218
|
-
```
|
|
219
|
-
USAGE
|
|
220
|
-
$ xano function edit [FUNCTION_ID] [-p <value>] [-w <value>] [-f <value> | -s] [-e] [--publish] [-o summary|json]
|
|
221
|
-
|
|
222
|
-
ARGUMENTS
|
|
223
|
-
FUNCTION_ID Function ID to edit
|
|
224
|
-
|
|
225
|
-
FLAGS
|
|
226
|
-
-e, --edit Open file in editor before updating function (requires --file)
|
|
227
|
-
-f, --file=<value> Path to file containing XanoScript code
|
|
228
|
-
-o, --output=<option> [default: summary] Output format
|
|
229
|
-
<options: summary|json>
|
|
230
|
-
-p, --profile=<value> [env: XANO_PROFILE] Profile to use for this command
|
|
231
|
-
-s, --stdin Read XanoScript code from stdin
|
|
232
|
-
-w, --workspace=<value> Workspace ID (optional if set in profile)
|
|
233
|
-
--publish Publish the function after editing
|
|
234
|
-
|
|
235
|
-
DESCRIPTION
|
|
236
|
-
Edit a function in a workspace
|
|
237
|
-
|
|
238
|
-
EXAMPLES
|
|
239
|
-
$ xano function:edit 163
|
|
240
|
-
# Fetches the function code and opens it in $EDITOR for editing
|
|
241
|
-
Function updated successfully!
|
|
242
|
-
ID: 163
|
|
243
|
-
Name: my_function
|
|
244
|
-
|
|
245
|
-
$ xano function:edit
|
|
246
|
-
# Prompts for function, fetches the code and opens it in $EDITOR for editing
|
|
247
|
-
Select a function to edit:
|
|
248
|
-
❯ my_function (ID: 163) - Sample function
|
|
249
|
-
another-func (ID: 164)
|
|
250
|
-
|
|
251
|
-
$ xano function:edit 163 -f function.xs
|
|
252
|
-
Function updated successfully!
|
|
253
|
-
ID: 163
|
|
254
|
-
Name: my_function
|
|
255
|
-
|
|
256
|
-
$ xano function:edit 163 -w 40 -f function.xs
|
|
257
|
-
Function updated successfully!
|
|
258
|
-
ID: 163
|
|
259
|
-
Name: my_function
|
|
260
|
-
|
|
261
|
-
$ xano function:edit -f function.xs
|
|
262
|
-
Select a function to edit:
|
|
263
|
-
❯ my_function (ID: 163) - Sample function
|
|
264
|
-
another-func (ID: 164)
|
|
265
|
-
|
|
266
|
-
$ xano function:edit 163 -f function.xs --edit
|
|
267
|
-
# Opens function.xs in $EDITOR, then updates function with edited content
|
|
268
|
-
Function updated successfully!
|
|
269
|
-
ID: 163
|
|
270
|
-
Name: my_function
|
|
271
|
-
|
|
272
|
-
$ cat function.xs | xano function:edit 163 --stdin
|
|
273
|
-
Function updated successfully!
|
|
274
|
-
ID: 163
|
|
275
|
-
Name: my_function
|
|
276
|
-
|
|
277
|
-
$ xano function:edit 163 -f function.xs -o json
|
|
278
|
-
{
|
|
279
|
-
"id": 163,
|
|
280
|
-
"name": "my_function",
|
|
281
|
-
...
|
|
282
|
-
}
|
|
283
|
-
```
|
|
284
|
-
|
|
285
|
-
_See code: [src/commands/function/edit/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/function/edit/index.ts)_
|
|
286
|
-
|
|
287
|
-
## `xano function get [FUNCTION_ID]`
|
|
288
|
-
|
|
289
|
-
Get a specific function from a workspace
|
|
290
|
-
|
|
291
|
-
```
|
|
292
|
-
USAGE
|
|
293
|
-
$ xano function get [FUNCTION_ID] [-p <value>] [-w <value>] [-o summary|json|xs] [--include_draft]
|
|
294
|
-
[--include_xanoscript]
|
|
295
|
-
|
|
296
|
-
ARGUMENTS
|
|
297
|
-
FUNCTION_ID Function ID
|
|
298
|
-
|
|
299
|
-
FLAGS
|
|
300
|
-
-o, --output=<option> [default: summary] Output format
|
|
301
|
-
<options: summary|json|xs>
|
|
302
|
-
-p, --profile=<value> [env: XANO_PROFILE] Profile to use for this command
|
|
303
|
-
-w, --workspace=<value> Workspace ID (optional if set in profile)
|
|
304
|
-
--include_draft Include draft version
|
|
305
|
-
--include_xanoscript Include XanoScript in response
|
|
306
|
-
|
|
307
|
-
DESCRIPTION
|
|
308
|
-
Get a specific function from a workspace
|
|
309
|
-
|
|
310
|
-
EXAMPLES
|
|
311
|
-
$ xano function:get 145 -w 40
|
|
312
|
-
Function: yo (ID: 145)
|
|
313
|
-
Created: 2025-10-10 10:30:00
|
|
314
|
-
Description: Sample function
|
|
315
|
-
|
|
316
|
-
$ xano function:get 145 --profile production
|
|
317
|
-
Function: yo (ID: 145)
|
|
318
|
-
Created: 2025-10-10 10:30:00
|
|
319
|
-
|
|
320
|
-
$ xano function:get
|
|
321
|
-
Select a function:
|
|
322
|
-
❯ yo (ID: 145) - Sample function
|
|
323
|
-
another-func (ID: 146)
|
|
324
|
-
|
|
325
|
-
$ xano function:get 145 -w 40 --output json
|
|
326
|
-
{
|
|
327
|
-
"id": 145,
|
|
328
|
-
"name": "yo",
|
|
329
|
-
"description": "Sample function"
|
|
330
|
-
}
|
|
331
|
-
|
|
332
|
-
$ xano function:get 145 -p staging -o json --include_draft
|
|
333
|
-
{
|
|
334
|
-
"id": 145,
|
|
335
|
-
"name": "yo"
|
|
336
|
-
}
|
|
337
|
-
|
|
338
|
-
$ xano function:get 145 -p staging -o xs
|
|
339
|
-
function yo {
|
|
340
|
-
input {
|
|
341
|
-
}
|
|
342
|
-
stack {
|
|
343
|
-
}
|
|
344
|
-
response = null
|
|
345
|
-
}
|
|
346
|
-
```
|
|
347
|
-
|
|
348
|
-
_See code: [src/commands/function/get/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/function/get/index.ts)_
|
|
349
|
-
|
|
350
|
-
## `xano function list`
|
|
351
|
-
|
|
352
|
-
List all functions in a workspace from the Xano Metadata API
|
|
353
|
-
|
|
354
|
-
```
|
|
355
|
-
USAGE
|
|
356
|
-
$ xano function list [-p <value>] [-w <value>] [-o summary|json] [--include_draft] [--include_xanoscript] [--page
|
|
357
|
-
<value>] [--per_page <value>] [--sort <value>] [--order asc|desc]
|
|
358
|
-
|
|
359
|
-
FLAGS
|
|
360
|
-
-o, --output=<option> [default: summary] Output format
|
|
361
|
-
<options: summary|json>
|
|
362
|
-
-p, --profile=<value> [env: XANO_PROFILE] Profile to use for this command
|
|
363
|
-
-w, --workspace=<value> Workspace ID (optional if set in profile)
|
|
364
|
-
--include_draft Include draft functions
|
|
365
|
-
--include_xanoscript Include XanoScript in response
|
|
366
|
-
--order=<option> [default: desc] Sort order
|
|
367
|
-
<options: asc|desc>
|
|
368
|
-
--page=<value> [default: 1] Page number for pagination
|
|
369
|
-
--per_page=<value> [default: 50] Number of results per page
|
|
370
|
-
--sort=<value> [default: created_at] Sort field
|
|
371
|
-
|
|
372
|
-
DESCRIPTION
|
|
373
|
-
List all functions in a workspace from the Xano Metadata API
|
|
374
|
-
|
|
375
|
-
EXAMPLES
|
|
376
|
-
$ xano function:list -w 40
|
|
377
|
-
Available functions:
|
|
378
|
-
- function-1 (ID: 1)
|
|
379
|
-
- function-2 (ID: 2)
|
|
380
|
-
- function-3 (ID: 3)
|
|
381
|
-
|
|
382
|
-
$ xano function:list --profile production
|
|
383
|
-
Available functions:
|
|
384
|
-
- my-function (ID: 1)
|
|
385
|
-
- another-function (ID: 2)
|
|
386
|
-
|
|
387
|
-
$ xano function:list -w 40 --output json
|
|
388
|
-
[
|
|
389
|
-
{
|
|
390
|
-
"id": 1,
|
|
391
|
-
"name": "function-1"
|
|
392
|
-
}
|
|
393
|
-
]
|
|
394
|
-
|
|
395
|
-
$ xano function:list -p staging -o json --include_draft
|
|
396
|
-
[
|
|
397
|
-
{
|
|
398
|
-
"id": 1,
|
|
399
|
-
"name": "function-1"
|
|
400
|
-
}
|
|
401
|
-
]
|
|
402
|
-
```
|
|
403
|
-
|
|
404
|
-
_See code: [src/commands/function/list/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/function/list/index.ts)_
|
|
405
|
-
|
|
406
|
-
## `xano help [COMMAND]`
|
|
407
|
-
|
|
408
|
-
Display help for xano.
|
|
409
|
-
|
|
410
|
-
```
|
|
411
|
-
USAGE
|
|
412
|
-
$ xano help [COMMAND...] [-n]
|
|
413
|
-
|
|
414
|
-
ARGUMENTS
|
|
415
|
-
COMMAND... Command to show help for.
|
|
416
|
-
|
|
417
|
-
FLAGS
|
|
418
|
-
-n, --nested-commands Include all nested commands in the output.
|
|
419
|
-
|
|
420
|
-
DESCRIPTION
|
|
421
|
-
Display help for xano.
|
|
422
|
-
```
|
|
423
|
-
|
|
424
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.33/src/commands/help.ts)_
|
|
425
|
-
|
|
426
|
-
## `xano plugins`
|
|
427
|
-
|
|
428
|
-
List installed plugins.
|
|
429
|
-
|
|
430
|
-
```
|
|
431
|
-
USAGE
|
|
432
|
-
$ xano plugins [--json] [--core]
|
|
433
|
-
|
|
434
|
-
FLAGS
|
|
435
|
-
--core Show core plugins.
|
|
436
|
-
|
|
437
|
-
GLOBAL FLAGS
|
|
438
|
-
--json Format output as json.
|
|
439
|
-
|
|
440
|
-
DESCRIPTION
|
|
441
|
-
List installed plugins.
|
|
442
|
-
|
|
443
|
-
EXAMPLES
|
|
444
|
-
$ xano plugins
|
|
445
|
-
```
|
|
446
|
-
|
|
447
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.49/src/commands/plugins/index.ts)_
|
|
448
|
-
|
|
449
|
-
## `xano plugins add PLUGIN`
|
|
450
|
-
|
|
451
|
-
Installs a plugin into xano.
|
|
452
|
-
|
|
453
|
-
```
|
|
454
|
-
USAGE
|
|
455
|
-
$ xano plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
|
|
456
|
-
|
|
457
|
-
ARGUMENTS
|
|
458
|
-
PLUGIN... Plugin to install.
|
|
459
|
-
|
|
460
|
-
FLAGS
|
|
461
|
-
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
|
|
462
|
-
-h, --help Show CLI help.
|
|
463
|
-
-s, --silent Silences npm output.
|
|
464
|
-
-v, --verbose Show verbose npm output.
|
|
465
|
-
|
|
466
|
-
GLOBAL FLAGS
|
|
467
|
-
--json Format output as json.
|
|
468
|
-
|
|
469
|
-
DESCRIPTION
|
|
470
|
-
Installs a plugin into xano.
|
|
471
|
-
|
|
472
|
-
Uses npm to install plugins.
|
|
473
|
-
|
|
474
|
-
Installation of a user-installed plugin will override a core plugin.
|
|
475
|
-
|
|
476
|
-
Use the XANO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
|
|
477
|
-
Use the XANO_NPM_REGISTRY environment variable to set the npm registry.
|
|
478
|
-
|
|
479
|
-
ALIASES
|
|
480
|
-
$ xano plugins add
|
|
481
|
-
|
|
482
|
-
EXAMPLES
|
|
483
|
-
Install a plugin from npm registry.
|
|
484
|
-
|
|
485
|
-
$ xano plugins add myplugin
|
|
486
|
-
|
|
487
|
-
Install a plugin from a github url.
|
|
488
|
-
|
|
489
|
-
$ xano plugins add https://github.com/someuser/someplugin
|
|
490
|
-
|
|
491
|
-
Install a plugin from a github slug.
|
|
492
|
-
|
|
493
|
-
$ xano plugins add someuser/someplugin
|
|
494
|
-
```
|
|
495
|
-
|
|
496
|
-
## `xano plugins:inspect PLUGIN...`
|
|
497
|
-
|
|
498
|
-
Displays installation properties of a plugin.
|
|
499
|
-
|
|
500
|
-
```
|
|
501
|
-
USAGE
|
|
502
|
-
$ xano plugins inspect PLUGIN...
|
|
503
|
-
|
|
504
|
-
ARGUMENTS
|
|
505
|
-
PLUGIN... [default: .] Plugin to inspect.
|
|
506
|
-
|
|
507
|
-
FLAGS
|
|
508
|
-
-h, --help Show CLI help.
|
|
509
|
-
-v, --verbose
|
|
510
|
-
|
|
511
|
-
GLOBAL FLAGS
|
|
512
|
-
--json Format output as json.
|
|
513
|
-
|
|
514
|
-
DESCRIPTION
|
|
515
|
-
Displays installation properties of a plugin.
|
|
516
|
-
|
|
517
|
-
EXAMPLES
|
|
518
|
-
$ xano plugins inspect myplugin
|
|
519
|
-
```
|
|
520
|
-
|
|
521
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.49/src/commands/plugins/inspect.ts)_
|
|
522
|
-
|
|
523
|
-
## `xano plugins install PLUGIN`
|
|
524
|
-
|
|
525
|
-
Installs a plugin into xano.
|
|
526
|
-
|
|
527
|
-
```
|
|
528
|
-
USAGE
|
|
529
|
-
$ xano plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
|
|
530
|
-
|
|
531
|
-
ARGUMENTS
|
|
532
|
-
PLUGIN... Plugin to install.
|
|
533
|
-
|
|
534
|
-
FLAGS
|
|
535
|
-
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
|
|
536
|
-
-h, --help Show CLI help.
|
|
537
|
-
-s, --silent Silences npm output.
|
|
538
|
-
-v, --verbose Show verbose npm output.
|
|
539
|
-
|
|
540
|
-
GLOBAL FLAGS
|
|
541
|
-
--json Format output as json.
|
|
542
|
-
|
|
543
|
-
DESCRIPTION
|
|
544
|
-
Installs a plugin into xano.
|
|
545
|
-
|
|
546
|
-
Uses npm to install plugins.
|
|
547
|
-
|
|
548
|
-
Installation of a user-installed plugin will override a core plugin.
|
|
549
|
-
|
|
550
|
-
Use the XANO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
|
|
551
|
-
Use the XANO_NPM_REGISTRY environment variable to set the npm registry.
|
|
552
|
-
|
|
553
|
-
ALIASES
|
|
554
|
-
$ xano plugins add
|
|
555
|
-
|
|
556
|
-
EXAMPLES
|
|
557
|
-
Install a plugin from npm registry.
|
|
558
|
-
|
|
559
|
-
$ xano plugins install myplugin
|
|
560
|
-
|
|
561
|
-
Install a plugin from a github url.
|
|
562
|
-
|
|
563
|
-
$ xano plugins install https://github.com/someuser/someplugin
|
|
564
|
-
|
|
565
|
-
Install a plugin from a github slug.
|
|
566
|
-
|
|
567
|
-
$ xano plugins install someuser/someplugin
|
|
568
|
-
```
|
|
569
|
-
|
|
570
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.49/src/commands/plugins/install.ts)_
|
|
571
|
-
|
|
572
|
-
## `xano plugins link PATH`
|
|
573
|
-
|
|
574
|
-
Links a plugin into the CLI for development.
|
|
575
|
-
|
|
576
|
-
```
|
|
577
|
-
USAGE
|
|
578
|
-
$ xano plugins link PATH [-h] [--install] [-v]
|
|
579
|
-
|
|
580
|
-
ARGUMENTS
|
|
581
|
-
PATH [default: .] path to plugin
|
|
582
|
-
|
|
583
|
-
FLAGS
|
|
584
|
-
-h, --help Show CLI help.
|
|
585
|
-
-v, --verbose
|
|
586
|
-
--[no-]install Install dependencies after linking the plugin.
|
|
587
|
-
|
|
588
|
-
DESCRIPTION
|
|
589
|
-
Links a plugin into the CLI for development.
|
|
590
|
-
|
|
591
|
-
Installation of a linked plugin will override a user-installed or core plugin.
|
|
592
|
-
|
|
593
|
-
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
594
|
-
command will override the user-installed or core plugin implementation. This is useful for development work.
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
EXAMPLES
|
|
598
|
-
$ xano plugins link myplugin
|
|
599
|
-
```
|
|
600
|
-
|
|
601
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.49/src/commands/plugins/link.ts)_
|
|
602
|
-
|
|
603
|
-
## `xano plugins remove [PLUGIN]`
|
|
604
|
-
|
|
605
|
-
Removes a plugin from the CLI.
|
|
606
|
-
|
|
607
|
-
```
|
|
608
|
-
USAGE
|
|
609
|
-
$ xano plugins remove [PLUGIN...] [-h] [-v]
|
|
610
|
-
|
|
611
|
-
ARGUMENTS
|
|
612
|
-
PLUGIN... plugin to uninstall
|
|
613
|
-
|
|
614
|
-
FLAGS
|
|
615
|
-
-h, --help Show CLI help.
|
|
616
|
-
-v, --verbose
|
|
617
|
-
|
|
618
|
-
DESCRIPTION
|
|
619
|
-
Removes a plugin from the CLI.
|
|
620
|
-
|
|
621
|
-
ALIASES
|
|
622
|
-
$ xano plugins unlink
|
|
623
|
-
$ xano plugins remove
|
|
624
|
-
|
|
625
|
-
EXAMPLES
|
|
626
|
-
$ xano plugins remove myplugin
|
|
627
|
-
```
|
|
628
|
-
|
|
629
|
-
## `xano plugins reset`
|
|
630
|
-
|
|
631
|
-
Remove all user-installed and linked plugins.
|
|
632
|
-
|
|
633
|
-
```
|
|
634
|
-
USAGE
|
|
635
|
-
$ xano plugins reset [--hard] [--reinstall]
|
|
636
|
-
|
|
637
|
-
FLAGS
|
|
638
|
-
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
|
|
639
|
-
--reinstall Reinstall all plugins after uninstalling.
|
|
640
|
-
```
|
|
641
|
-
|
|
642
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.49/src/commands/plugins/reset.ts)_
|
|
643
|
-
|
|
644
|
-
## `xano plugins uninstall [PLUGIN]`
|
|
645
|
-
|
|
646
|
-
Removes a plugin from the CLI.
|
|
647
|
-
|
|
648
|
-
```
|
|
649
|
-
USAGE
|
|
650
|
-
$ xano plugins uninstall [PLUGIN...] [-h] [-v]
|
|
651
|
-
|
|
652
|
-
ARGUMENTS
|
|
653
|
-
PLUGIN... plugin to uninstall
|
|
654
|
-
|
|
655
|
-
FLAGS
|
|
656
|
-
-h, --help Show CLI help.
|
|
657
|
-
-v, --verbose
|
|
658
|
-
|
|
659
|
-
DESCRIPTION
|
|
660
|
-
Removes a plugin from the CLI.
|
|
661
|
-
|
|
662
|
-
ALIASES
|
|
663
|
-
$ xano plugins unlink
|
|
664
|
-
$ xano plugins remove
|
|
665
|
-
|
|
666
|
-
EXAMPLES
|
|
667
|
-
$ xano plugins uninstall myplugin
|
|
10
|
+
```bash
|
|
11
|
+
npm install -g @xano/cli
|
|
668
12
|
```
|
|
669
13
|
|
|
670
|
-
|
|
14
|
+
## Quick Start
|
|
671
15
|
|
|
672
|
-
|
|
16
|
+
1. Create a profile with the wizard:
|
|
17
|
+
```bash
|
|
18
|
+
xano profile:wizard
|
|
19
|
+
```
|
|
673
20
|
|
|
674
|
-
|
|
21
|
+
2. List your workspaces:
|
|
22
|
+
```bash
|
|
23
|
+
xano workspace:list
|
|
24
|
+
```
|
|
675
25
|
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
26
|
+
3. Run an ephemeral job:
|
|
27
|
+
```bash
|
|
28
|
+
xano ephemeral:run:job -f script.xs
|
|
29
|
+
```
|
|
679
30
|
|
|
680
|
-
|
|
681
|
-
PLUGIN... plugin to uninstall
|
|
31
|
+
## Commands
|
|
682
32
|
|
|
683
|
-
|
|
684
|
-
-h, --help Show CLI help.
|
|
685
|
-
-v, --verbose
|
|
33
|
+
### Profile Management
|
|
686
34
|
|
|
687
|
-
|
|
688
|
-
Removes a plugin from the CLI.
|
|
35
|
+
Profiles store your Xano credentials and default workspace settings.
|
|
689
36
|
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
37
|
+
```bash
|
|
38
|
+
# Create a profile interactively
|
|
39
|
+
xano profile:wizard
|
|
693
40
|
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
```
|
|
41
|
+
# Create a profile manually
|
|
42
|
+
xano profile:create myprofile -i https://instance.xano.com -t <access_token>
|
|
697
43
|
|
|
698
|
-
|
|
44
|
+
# List profiles
|
|
45
|
+
xano profile:list
|
|
46
|
+
xano profile:list --details
|
|
699
47
|
|
|
700
|
-
|
|
48
|
+
# Set default profile
|
|
49
|
+
xano profile:set-default myprofile
|
|
701
50
|
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
$ xano plugins update [-h] [-v]
|
|
51
|
+
# Edit a profile
|
|
52
|
+
xano profile:edit myprofile -w 123 # Set default workspace
|
|
705
53
|
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
-v, --verbose
|
|
709
|
-
|
|
710
|
-
DESCRIPTION
|
|
711
|
-
Update installed plugins.
|
|
54
|
+
# Delete a profile
|
|
55
|
+
xano profile:delete myprofile
|
|
712
56
|
```
|
|
713
57
|
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
## `xano profile create NAME`
|
|
717
|
-
|
|
718
|
-
Create a new profile configuration
|
|
58
|
+
### Workspaces
|
|
719
59
|
|
|
60
|
+
```bash
|
|
61
|
+
# List all workspaces
|
|
62
|
+
xano workspace:list
|
|
63
|
+
xano workspace:list -o json
|
|
720
64
|
```
|
|
721
|
-
USAGE
|
|
722
|
-
$ xano profile create NAME -i <value> -t <value> [-a <value>] [-w <value>] [-b <value>] [--default]
|
|
723
|
-
|
|
724
|
-
ARGUMENTS
|
|
725
|
-
NAME Profile name
|
|
726
|
-
|
|
727
|
-
FLAGS
|
|
728
|
-
-a, --account_origin=<value> Account origin URL. Optional for self hosted installs.
|
|
729
|
-
-b, --branch=<value> Branch name
|
|
730
|
-
-i, --instance_origin=<value> (required) Instance origin URL
|
|
731
|
-
-t, --access_token=<value> (required) Access token for the Xano Metadata API
|
|
732
|
-
-w, --workspace=<value> Workspace name
|
|
733
|
-
--default Set this profile as the default
|
|
734
65
|
|
|
735
|
-
|
|
736
|
-
Create a new profile configuration
|
|
66
|
+
### Functions
|
|
737
67
|
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
68
|
+
```bash
|
|
69
|
+
# List functions in a workspace
|
|
70
|
+
xano function:list -w 40
|
|
71
|
+
xano function:list -o json
|
|
741
72
|
|
|
742
|
-
|
|
743
|
-
|
|
73
|
+
# Get a specific function
|
|
74
|
+
xano function:get 145
|
|
75
|
+
xano function:get 145 -o xs # Output as XanoScript
|
|
744
76
|
|
|
745
|
-
|
|
746
|
-
|
|
77
|
+
# Create a function from XanoScript
|
|
78
|
+
xano function:create -f function.xs
|
|
79
|
+
cat function.xs | xano function:create --stdin
|
|
747
80
|
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
81
|
+
# Edit a function
|
|
82
|
+
xano function:edit 145 # Opens in $EDITOR
|
|
83
|
+
xano function:edit 145 -f new.xs # Update from file
|
|
84
|
+
xano function:edit 145 --publish # Publish after editing
|
|
751
85
|
```
|
|
752
86
|
|
|
753
|
-
|
|
87
|
+
### Ephemeral Jobs & Services
|
|
754
88
|
|
|
755
|
-
|
|
89
|
+
Run XanoScript code without creating permanent resources.
|
|
756
90
|
|
|
757
|
-
|
|
91
|
+
```bash
|
|
92
|
+
# Run a job (executes and returns result)
|
|
93
|
+
xano ephemeral:run:job -f script.xs
|
|
94
|
+
xano ephemeral:run:job -f script.xs -a args.json # With input arguments
|
|
95
|
+
xano ephemeral:run:job -f script.xs --edit # Edit in $EDITOR first
|
|
758
96
|
|
|
97
|
+
# Run a service (starts API endpoints)
|
|
98
|
+
xano ephemeral:run:service -f service.xs
|
|
759
99
|
```
|
|
760
|
-
USAGE
|
|
761
|
-
$ xano profile delete NAME [-f]
|
|
762
|
-
|
|
763
|
-
ARGUMENTS
|
|
764
|
-
NAME Profile name to delete
|
|
765
|
-
|
|
766
|
-
FLAGS
|
|
767
|
-
-f, --force Skip confirmation prompt
|
|
768
100
|
|
|
769
|
-
|
|
770
|
-
Delete a profile configuration
|
|
101
|
+
### Static Hosts
|
|
771
102
|
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
Profile 'old-profile' deleted successfully from ~/.xano/credentials.yaml
|
|
103
|
+
```bash
|
|
104
|
+
# List static hosts
|
|
105
|
+
xano static_host:list
|
|
776
106
|
|
|
777
|
-
|
|
778
|
-
|
|
107
|
+
# Create a build
|
|
108
|
+
xano static_host:build:create default -f ./build.zip -n "v1.0.0"
|
|
779
109
|
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
```
|
|
783
|
-
|
|
784
|
-
_See code: [src/commands/profile/delete/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/profile/delete/index.ts)_
|
|
785
|
-
|
|
786
|
-
## `xano profile edit NAME`
|
|
787
|
-
|
|
788
|
-
Edit an existing profile configuration
|
|
110
|
+
# List builds
|
|
111
|
+
xano static_host:build:list default
|
|
789
112
|
|
|
113
|
+
# Get build details
|
|
114
|
+
xano static_host:build:get default 52
|
|
790
115
|
```
|
|
791
|
-
USAGE
|
|
792
|
-
$ xano profile edit NAME [-a <value>] [-i <value>] [-t <value>] [-w <value>] [-b <value>] [--remove-workspace]
|
|
793
|
-
[--remove-branch]
|
|
794
|
-
|
|
795
|
-
ARGUMENTS
|
|
796
|
-
NAME Profile name to edit
|
|
797
116
|
|
|
798
|
-
|
|
799
|
-
-a, --account_origin=<value> Update account origin URL
|
|
800
|
-
-b, --branch=<value> Update branch name
|
|
801
|
-
-i, --instance_origin=<value> Update instance origin URL
|
|
802
|
-
-t, --access_token=<value> Update access token for the Xano Metadata API
|
|
803
|
-
-w, --workspace=<value> Update workspace name
|
|
804
|
-
--remove-branch Remove branch from profile
|
|
805
|
-
--remove-workspace Remove workspace from profile
|
|
117
|
+
## Global Options
|
|
806
118
|
|
|
807
|
-
|
|
808
|
-
Edit an existing profile configuration
|
|
809
|
-
|
|
810
|
-
EXAMPLES
|
|
811
|
-
$ xano profile:edit production --access_token new_token123
|
|
812
|
-
Profile 'production' updated successfully at ~/.xano/credentials.yaml
|
|
813
|
-
|
|
814
|
-
$ xano profile:edit staging -i https://new-staging-instance.xano.com -t new_token456
|
|
815
|
-
Profile 'staging' updated successfully at ~/.xano/credentials.yaml
|
|
816
|
-
|
|
817
|
-
$ xano profile:edit dev -w new-workspace -b new-branch
|
|
818
|
-
Profile 'dev' updated successfully at ~/.xano/credentials.yaml
|
|
819
|
-
|
|
820
|
-
$ xano profile:edit dev --remove-workspace
|
|
821
|
-
Profile 'dev' updated successfully at ~/.xano/credentials.yaml
|
|
822
|
-
```
|
|
119
|
+
All commands support these options:
|
|
823
120
|
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
```
|
|
831
|
-
USAGE
|
|
832
|
-
$ xano profile get-default
|
|
833
|
-
|
|
834
|
-
DESCRIPTION
|
|
835
|
-
Get the current default profile name
|
|
836
|
-
|
|
837
|
-
EXAMPLES
|
|
838
|
-
$ xano profile:get-default
|
|
839
|
-
production
|
|
840
|
-
|
|
841
|
-
$ xano profile:get-default
|
|
842
|
-
No default profile set
|
|
843
|
-
```
|
|
844
|
-
|
|
845
|
-
_See code: [src/commands/profile/get-default/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/profile/get-default/index.ts)_
|
|
846
|
-
|
|
847
|
-
## `xano profile list`
|
|
848
|
-
|
|
849
|
-
List all available profile configurations
|
|
850
|
-
|
|
851
|
-
```
|
|
852
|
-
USAGE
|
|
853
|
-
$ xano profile list [-d]
|
|
854
|
-
|
|
855
|
-
FLAGS
|
|
856
|
-
-d, --details Show detailed information for each profile
|
|
857
|
-
|
|
858
|
-
DESCRIPTION
|
|
859
|
-
List all available profile configurations
|
|
860
|
-
|
|
861
|
-
EXAMPLES
|
|
862
|
-
$ xano profile:list
|
|
863
|
-
Available profiles:
|
|
864
|
-
- default
|
|
865
|
-
- production
|
|
866
|
-
- staging
|
|
867
|
-
- development
|
|
868
|
-
|
|
869
|
-
$ xano profile:list --details
|
|
870
|
-
Available profiles:
|
|
871
|
-
Profile: default
|
|
872
|
-
Account Origin: https://account.xano.com
|
|
873
|
-
Instance Origin: https://instance.xano.com
|
|
874
|
-
Access Token: ***...***
|
|
875
|
-
Workspace: my-workspace
|
|
876
|
-
Branch: main
|
|
877
|
-
Profile: production
|
|
878
|
-
Account Origin: https://account.xano.com
|
|
879
|
-
Instance Origin: https://prod-instance.xano.com
|
|
880
|
-
Access Token: ***...***
|
|
881
|
-
|
|
882
|
-
$ xano profile:list -d
|
|
883
|
-
Available profiles:
|
|
884
|
-
Profile: default
|
|
885
|
-
Account Origin: https://account.xano.com
|
|
886
|
-
Instance Origin: https://instance.xano.com
|
|
887
|
-
Access Token: ***...***
|
|
888
|
-
Workspace: my-workspace
|
|
889
|
-
Branch: main
|
|
890
|
-
```
|
|
121
|
+
| Flag | Description |
|
|
122
|
+
|------|-------------|
|
|
123
|
+
| `-p, --profile` | Profile to use (or set `XANO_PROFILE` env var) |
|
|
124
|
+
| `-w, --workspace` | Workspace ID (overrides profile default) |
|
|
125
|
+
| `-o, --output` | Output format: `summary` (default) or `json` |
|
|
891
126
|
|
|
892
|
-
|
|
127
|
+
## Configuration
|
|
893
128
|
|
|
894
|
-
|
|
129
|
+
Profiles are stored in `~/.xano/credentials.yaml`.
|
|
895
130
|
|
|
896
|
-
|
|
131
|
+
## Help
|
|
897
132
|
|
|
133
|
+
```bash
|
|
134
|
+
xano --help
|
|
135
|
+
xano <command> --help
|
|
898
136
|
```
|
|
899
|
-
USAGE
|
|
900
|
-
$ xano profile set-default NAME
|
|
901
|
-
|
|
902
|
-
ARGUMENTS
|
|
903
|
-
NAME Profile name to set as default
|
|
904
|
-
|
|
905
|
-
DESCRIPTION
|
|
906
|
-
Set the default profile
|
|
907
|
-
|
|
908
|
-
EXAMPLES
|
|
909
|
-
$ xano profile:set-default production
|
|
910
|
-
Default profile set to 'production'
|
|
911
|
-
|
|
912
|
-
$ xano profile:set-default staging
|
|
913
|
-
Default profile set to 'staging'
|
|
914
|
-
```
|
|
915
|
-
|
|
916
|
-
_See code: [src/commands/profile/set-default/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/profile/set-default/index.ts)_
|
|
917
|
-
|
|
918
|
-
## `xano profile wizard`
|
|
919
|
-
|
|
920
|
-
Create a new profile configuration using an interactive wizard
|
|
921
|
-
|
|
922
|
-
```
|
|
923
|
-
USAGE
|
|
924
|
-
$ xano profile wizard [-n <value>] [-o <value>]
|
|
925
|
-
|
|
926
|
-
FLAGS
|
|
927
|
-
-n, --name=<value> Profile name (skip prompt if provided)
|
|
928
|
-
-o, --origin=<value> [default: https://app.xano.com] Xano instance origin URL
|
|
929
|
-
|
|
930
|
-
DESCRIPTION
|
|
931
|
-
Create a new profile configuration using an interactive wizard
|
|
932
|
-
|
|
933
|
-
EXAMPLES
|
|
934
|
-
$ xano profile:wizard
|
|
935
|
-
Welcome to the Xano Profile Wizard!
|
|
936
|
-
? Enter your access token: ***...***
|
|
937
|
-
? Select an instance:
|
|
938
|
-
> Production (https://app.xano.com)
|
|
939
|
-
Staging (https://staging.xano.com)
|
|
940
|
-
? Profile name: production
|
|
941
|
-
Profile 'production' created successfully at ~/.xano/credentials.yaml
|
|
942
|
-
```
|
|
943
|
-
|
|
944
|
-
_See code: [src/commands/profile/wizard/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/profile/wizard/index.ts)_
|
|
945
|
-
|
|
946
|
-
## `xano static_host build create STATIC_HOST`
|
|
947
|
-
|
|
948
|
-
Create a new build for a static host
|
|
949
|
-
|
|
950
|
-
```
|
|
951
|
-
USAGE
|
|
952
|
-
$ xano static_host build create STATIC_HOST -f <value> -n <value> [-p <value>] [-w <value>] [-d <value>] [-o
|
|
953
|
-
summary|json]
|
|
954
|
-
|
|
955
|
-
ARGUMENTS
|
|
956
|
-
STATIC_HOST Static Host name
|
|
957
|
-
|
|
958
|
-
FLAGS
|
|
959
|
-
-d, --description=<value> Build description
|
|
960
|
-
-f, --file=<value> (required) Path to zip file to upload
|
|
961
|
-
-n, --name=<value> (required) Build name
|
|
962
|
-
-o, --output=<option> [default: summary] Output format
|
|
963
|
-
<options: summary|json>
|
|
964
|
-
-p, --profile=<value> [env: XANO_PROFILE] Profile to use for this command
|
|
965
|
-
-w, --workspace=<value> Workspace ID (optional if set in profile)
|
|
966
|
-
|
|
967
|
-
DESCRIPTION
|
|
968
|
-
Create a new build for a static host
|
|
969
|
-
|
|
970
|
-
EXAMPLES
|
|
971
|
-
$ xano static_host:build:create default -f ./build.zip -n "v1.0.0"
|
|
972
|
-
Build created successfully!
|
|
973
|
-
ID: 123
|
|
974
|
-
Name: v1.0.0
|
|
975
|
-
Status: pending
|
|
976
|
-
|
|
977
|
-
$ xano static_host:build:create default -w 40 -f ./dist.zip -n "production" -d "Production build"
|
|
978
|
-
Build created successfully!
|
|
979
|
-
ID: 124
|
|
980
|
-
Name: production
|
|
981
|
-
Description: Production build
|
|
982
|
-
|
|
983
|
-
$ xano static_host:build:create myhost -f ./app.zip -n "release-1.2" -o json
|
|
984
|
-
{
|
|
985
|
-
"id": 125,
|
|
986
|
-
"name": "release-1.2",
|
|
987
|
-
"status": "pending"
|
|
988
|
-
}
|
|
989
|
-
```
|
|
990
|
-
|
|
991
|
-
_See code: [src/commands/static_host/build/create/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/static_host/build/create/index.ts)_
|
|
992
|
-
|
|
993
|
-
## `xano static_host build get STATIC_HOST BUILD_ID`
|
|
994
|
-
|
|
995
|
-
Get details of a specific build for a static host
|
|
996
|
-
|
|
997
|
-
```
|
|
998
|
-
USAGE
|
|
999
|
-
$ xano static_host build get STATIC_HOST BUILD_ID [-p <value>] [-w <value>] [-o summary|json]
|
|
1000
|
-
|
|
1001
|
-
ARGUMENTS
|
|
1002
|
-
STATIC_HOST Static Host name
|
|
1003
|
-
BUILD_ID Build ID
|
|
1004
|
-
|
|
1005
|
-
FLAGS
|
|
1006
|
-
-o, --output=<option> [default: summary] Output format
|
|
1007
|
-
<options: summary|json>
|
|
1008
|
-
-p, --profile=<value> [env: XANO_PROFILE] Profile to use for this command
|
|
1009
|
-
-w, --workspace=<value> Workspace ID (optional if set in profile)
|
|
1010
|
-
|
|
1011
|
-
DESCRIPTION
|
|
1012
|
-
Get details of a specific build for a static host
|
|
1013
|
-
|
|
1014
|
-
EXAMPLES
|
|
1015
|
-
$ xano static_host:build:get default 52
|
|
1016
|
-
Build Details:
|
|
1017
|
-
ID: 52
|
|
1018
|
-
Name: v1.0.0
|
|
1019
|
-
Status: completed
|
|
1020
|
-
|
|
1021
|
-
$ xano static_host:build:get default 52 -w 40
|
|
1022
|
-
Build Details:
|
|
1023
|
-
ID: 52
|
|
1024
|
-
Name: v1.0.0
|
|
1025
|
-
Status: completed
|
|
1026
|
-
|
|
1027
|
-
$ xano static_host:build:get myhost 123 --profile production
|
|
1028
|
-
Build Details:
|
|
1029
|
-
ID: 123
|
|
1030
|
-
Name: production-build
|
|
1031
|
-
|
|
1032
|
-
$ xano static_host:build:get default 52 -o json
|
|
1033
|
-
{
|
|
1034
|
-
"id": 52,
|
|
1035
|
-
"name": "v1.0.0",
|
|
1036
|
-
"status": "completed"
|
|
1037
|
-
}
|
|
1038
|
-
```
|
|
1039
|
-
|
|
1040
|
-
_See code: [src/commands/static_host/build/get/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/static_host/build/get/index.ts)_
|
|
1041
|
-
|
|
1042
|
-
## `xano static_host build list STATIC_HOST`
|
|
1043
|
-
|
|
1044
|
-
List all builds for a static host
|
|
1045
|
-
|
|
1046
|
-
```
|
|
1047
|
-
USAGE
|
|
1048
|
-
$ xano static_host build list STATIC_HOST [-p <value>] [-w <value>] [-o summary|json] [--page <value>] [--per_page
|
|
1049
|
-
<value>]
|
|
1050
|
-
|
|
1051
|
-
ARGUMENTS
|
|
1052
|
-
STATIC_HOST Static Host name
|
|
1053
|
-
|
|
1054
|
-
FLAGS
|
|
1055
|
-
-o, --output=<option> [default: summary] Output format
|
|
1056
|
-
<options: summary|json>
|
|
1057
|
-
-p, --profile=<value> [env: XANO_PROFILE] Profile to use for this command
|
|
1058
|
-
-w, --workspace=<value> Workspace ID (optional if set in profile)
|
|
1059
|
-
--page=<value> [default: 1] Page number for pagination
|
|
1060
|
-
--per_page=<value> [default: 50] Number of results per page
|
|
1061
|
-
|
|
1062
|
-
DESCRIPTION
|
|
1063
|
-
List all builds for a static host
|
|
1064
|
-
|
|
1065
|
-
EXAMPLES
|
|
1066
|
-
$ xano static_host:build:list default -w 40
|
|
1067
|
-
Available builds:
|
|
1068
|
-
- v1.0.0 (ID: 1) - Status: completed
|
|
1069
|
-
- v1.0.1 (ID: 2) - Status: pending
|
|
1070
|
-
|
|
1071
|
-
$ xano static_host:build:list myhost --profile production
|
|
1072
|
-
Available builds:
|
|
1073
|
-
- production (ID: 1) - Status: completed
|
|
1074
|
-
- staging (ID: 2) - Status: completed
|
|
1075
|
-
|
|
1076
|
-
$ xano static_host:build:list default -w 40 --output json
|
|
1077
|
-
[
|
|
1078
|
-
{
|
|
1079
|
-
"id": 1,
|
|
1080
|
-
"name": "v1.0.0",
|
|
1081
|
-
"status": "completed"
|
|
1082
|
-
}
|
|
1083
|
-
]
|
|
1084
|
-
|
|
1085
|
-
$ xano static_host:build:list default -p staging -o json --page 2
|
|
1086
|
-
[
|
|
1087
|
-
{
|
|
1088
|
-
"id": 3,
|
|
1089
|
-
"name": "v1.0.2"
|
|
1090
|
-
}
|
|
1091
|
-
]
|
|
1092
|
-
```
|
|
1093
|
-
|
|
1094
|
-
_See code: [src/commands/static_host/build/list/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/static_host/build/list/index.ts)_
|
|
1095
|
-
|
|
1096
|
-
## `xano static_host list`
|
|
1097
|
-
|
|
1098
|
-
List all static hosts in a workspace from the Xano Metadata API
|
|
1099
|
-
|
|
1100
|
-
```
|
|
1101
|
-
USAGE
|
|
1102
|
-
$ xano static_host list [-p <value>] [-w <value>] [-o summary|json] [--page <value>] [--per_page <value>]
|
|
1103
|
-
|
|
1104
|
-
FLAGS
|
|
1105
|
-
-o, --output=<option> [default: summary] Output format
|
|
1106
|
-
<options: summary|json>
|
|
1107
|
-
-p, --profile=<value> [env: XANO_PROFILE] Profile to use for this command
|
|
1108
|
-
-w, --workspace=<value> Workspace ID (optional if set in profile)
|
|
1109
|
-
--page=<value> [default: 1] Page number for pagination
|
|
1110
|
-
--per_page=<value> [default: 50] Number of results per page
|
|
1111
|
-
|
|
1112
|
-
DESCRIPTION
|
|
1113
|
-
List all static hosts in a workspace from the Xano Metadata API
|
|
1114
|
-
|
|
1115
|
-
EXAMPLES
|
|
1116
|
-
$ xano static_host:list -w 40
|
|
1117
|
-
Available static hosts:
|
|
1118
|
-
- my-static-host (ID: 1)
|
|
1119
|
-
- another-host (ID: 2)
|
|
1120
|
-
|
|
1121
|
-
$ xano static_host:list --profile production
|
|
1122
|
-
Available static hosts:
|
|
1123
|
-
- my-static-host (ID: 1)
|
|
1124
|
-
- another-host (ID: 2)
|
|
1125
|
-
|
|
1126
|
-
$ xano static_host:list -w 40 --output json
|
|
1127
|
-
[
|
|
1128
|
-
{
|
|
1129
|
-
"id": 1,
|
|
1130
|
-
"name": "my-static-host",
|
|
1131
|
-
"domain": "example.com"
|
|
1132
|
-
}
|
|
1133
|
-
]
|
|
1134
|
-
|
|
1135
|
-
$ xano static_host:list -p staging -o json --page 2
|
|
1136
|
-
[
|
|
1137
|
-
{
|
|
1138
|
-
"id": 3,
|
|
1139
|
-
"name": "static-host-3"
|
|
1140
|
-
}
|
|
1141
|
-
]
|
|
1142
|
-
```
|
|
1143
|
-
|
|
1144
|
-
_See code: [src/commands/static_host/list/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/static_host/list/index.ts)_
|
|
1145
|
-
|
|
1146
|
-
## `xano workspace list`
|
|
1147
|
-
|
|
1148
|
-
List all workspaces from the Xano Metadata API
|
|
1149
|
-
|
|
1150
|
-
```
|
|
1151
|
-
USAGE
|
|
1152
|
-
$ xano workspace list [-p <value>] [-o summary|json]
|
|
1153
|
-
|
|
1154
|
-
FLAGS
|
|
1155
|
-
-o, --output=<option> [default: summary] Output format
|
|
1156
|
-
<options: summary|json>
|
|
1157
|
-
-p, --profile=<value> [env: XANO_PROFILE] Profile to use for this command
|
|
1158
|
-
|
|
1159
|
-
DESCRIPTION
|
|
1160
|
-
List all workspaces from the Xano Metadata API
|
|
1161
|
-
|
|
1162
|
-
EXAMPLES
|
|
1163
|
-
$ xano workspace:list
|
|
1164
|
-
Available workspaces:
|
|
1165
|
-
- workspace-1 (ID: 1)
|
|
1166
|
-
- workspace-2 (ID: 2)
|
|
1167
|
-
- workspace-3 (ID: 3)
|
|
1168
|
-
|
|
1169
|
-
$ xano workspace:list --profile production
|
|
1170
|
-
Available workspaces:
|
|
1171
|
-
- my-app (ID: 1)
|
|
1172
|
-
- staging-env (ID: 2)
|
|
1173
|
-
|
|
1174
|
-
$ xano workspace:list --output json
|
|
1175
|
-
{
|
|
1176
|
-
"workspaces": [
|
|
1177
|
-
{
|
|
1178
|
-
"id": 1,
|
|
1179
|
-
"name": "workspace-1"
|
|
1180
|
-
},
|
|
1181
|
-
{
|
|
1182
|
-
"id": 2,
|
|
1183
|
-
"name": "workspace-2"
|
|
1184
|
-
}
|
|
1185
|
-
]
|
|
1186
|
-
}
|
|
1187
|
-
|
|
1188
|
-
$ xano workspace:list -p staging -o json
|
|
1189
|
-
{
|
|
1190
|
-
"workspaces": [
|
|
1191
|
-
{
|
|
1192
|
-
"id": 1,
|
|
1193
|
-
"name": "my-app"
|
|
1194
|
-
}
|
|
1195
|
-
]
|
|
1196
|
-
}
|
|
1197
|
-
```
|
|
1198
|
-
|
|
1199
|
-
_See code: [src/commands/workspace/list/index.ts](https://github.com/xano-inc/cli/blob/v0.0.4/src/commands/workspace/list/index.ts)_
|
|
1200
|
-
<!-- commandsstop -->
|