indraq_cli 2.7.1 → 2.7.3
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/cloud-api/dist/index.js +69 -0
- package/cloud-api/package.json +1 -1
- package/cloud-api/src/index.ts +42 -0
- package/dist/cli/help-content.d.ts.map +1 -1
- package/dist/cli/help-content.js +8 -5
- package/dist/cli/help-content.js.map +1 -1
- package/dist/modules/mobile/commands/build-mobile.command.d.ts +1 -0
- package/dist/modules/mobile/commands/build-mobile.command.d.ts.map +1 -1
- package/dist/modules/mobile/commands/build-mobile.command.js +39 -21
- package/dist/modules/mobile/commands/build-mobile.command.js.map +1 -1
- package/dist/modules/mobile/commands/mobile-build-wizard.command.d.ts +15 -0
- package/dist/modules/mobile/commands/mobile-build-wizard.command.d.ts.map +1 -0
- package/dist/modules/mobile/commands/mobile-build-wizard.command.js +134 -0
- package/dist/modules/mobile/commands/mobile-build-wizard.command.js.map +1 -0
- package/dist/modules/mobile/commands/mobile-environment.command.d.ts.map +1 -1
- package/dist/modules/mobile/commands/mobile-environment.command.js +4 -6
- package/dist/modules/mobile/commands/mobile-environment.command.js.map +1 -1
- package/dist/modules/mobile/commands/mobile-prebuild.command.d.ts +2 -0
- package/dist/modules/mobile/commands/mobile-prebuild.command.d.ts.map +1 -1
- package/dist/modules/mobile/commands/mobile-prebuild.command.js +4 -4
- package/dist/modules/mobile/commands/mobile-prebuild.command.js.map +1 -1
- package/dist/modules/mobile/commands/ota.command.d.ts +1 -0
- package/dist/modules/mobile/commands/ota.command.d.ts.map +1 -1
- package/dist/modules/mobile/commands/ota.command.js +37 -1
- package/dist/modules/mobile/commands/ota.command.js.map +1 -1
- package/dist/modules/mobile/config/mobile-config.d.ts +1 -0
- package/dist/modules/mobile/config/mobile-config.d.ts.map +1 -1
- package/dist/modules/mobile/config/mobile-config.js +6 -1
- package/dist/modules/mobile/config/mobile-config.js.map +1 -1
- package/dist/modules/mobile/index.d.ts.map +1 -1
- package/dist/modules/mobile/index.js +18 -1
- package/dist/modules/mobile/index.js.map +1 -1
- package/dist/modules/scopes/commands/scope.command.d.ts +2 -0
- package/dist/modules/scopes/commands/scope.command.d.ts.map +1 -1
- package/dist/modules/scopes/commands/scope.command.js +125 -3
- package/dist/modules/scopes/commands/scope.command.js.map +1 -1
- package/dist/modules/scopes/index.d.ts.map +1 -1
- package/dist/modules/scopes/index.js +1 -0
- package/dist/modules/scopes/index.js.map +1 -1
- package/dist/modules/scopes/services/native-scope-inspection.service.d.ts +10 -0
- package/dist/modules/scopes/services/native-scope-inspection.service.d.ts.map +1 -0
- package/dist/modules/scopes/services/native-scope-inspection.service.js +75 -0
- package/dist/modules/scopes/services/native-scope-inspection.service.js.map +1 -0
- package/dist/modules/scopes/services/scope-native.service.d.ts +2 -0
- package/dist/modules/scopes/services/scope-native.service.d.ts.map +1 -1
- package/dist/modules/scopes/services/scope-native.service.js +43 -5
- package/dist/modules/scopes/services/scope-native.service.js.map +1 -1
- package/dist/modules/users/providers/npm-user.provider.d.ts +11 -0
- package/dist/modules/users/providers/npm-user.provider.d.ts.map +1 -1
- package/dist/modules/users/providers/npm-user.provider.js +16 -1
- package/dist/modules/users/providers/npm-user.provider.js.map +1 -1
- package/docs/assets/architecture.png +0 -0
- package/docs/assets/architecture.svg +123 -0
- package/docs/assets/backend-mobile.png +0 -0
- package/docs/assets/backend-mobile.svg +97 -0
- package/docs/assets/cleanup.png +0 -0
- package/docs/assets/cleanup.svg +104 -0
- package/docs/assets/setup-flow.png +0 -0
- package/docs/assets/setup-flow.svg +95 -0
- package/docs/assets/web-deployment.png +0 -0
- package/docs/assets/web-deployment.svg +72 -0
- package/package.json +9 -4
- package/README.md +0 -778
package/README.md
DELETED
|
@@ -1,778 +0,0 @@
|
|
|
1
|
-
# IndraQ CLI v2.7.1
|
|
2
|
-
|
|
3
|
-
IndraQ CLI helps our team set up, build and deploy web and mobile apps.
|
|
4
|
-
|
|
5
|
-
This guide uses simple steps. Start with the **Developer quick start**.
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## v2.7.1: Mobile prebuild fixes (quick guide)
|
|
10
|
-
|
|
11
|
-
`indraq project create` with **Backend + Mobile App** now offers to configure the mobile app immediately after the backend finishes. Answer **Yes** and select your mobile environment. You no longer need to run `indraq setup` solely to start the mobile half.
|
|
12
|
-
|
|
13
|
-
If a mobile Expo `app.json` contains commented entries (for example `// "./plugin"`) or trailing commas, IndraQ can now read it. Before rewriting it as normal JSON, IndraQ saves the original to `mobile/.indraq/backups/app.json.before-normalization`. Other config fields are kept. If the JSON is still invalid, IndraQ reports the filename **before** changing Jenkins or registering an OTA key.
|
|
14
|
-
|
|
15
|
-
For an existing combined project, run:
|
|
16
|
-
|
|
17
|
-
```powershell
|
|
18
|
-
cd mobile
|
|
19
|
-
indraq mobile prebuild --env immortility
|
|
20
|
-
indraq build mobile:dev --dry-run
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
The existing `immortility` environment is a **Development** build environment, even though it uses the Jenkins **PROD** controller. A production build requires a separate **Production** mobile environment.
|
|
24
|
-
|
|
25
|
-
**Deployment:** This hotfix only updates the CLI. Keep the Cloud API v1.3.0 from the v2.7 release; there is no new database migration.
|
|
26
|
-
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
## v2.7 foundation (quick guide)
|
|
30
|
-
|
|
31
|
-
### Backend + Mobile App
|
|
32
|
-
|
|
33
|
-
`indraq init` and `indraq project create` both offer **Backend + Mobile App**.
|
|
34
|
-
The generated project contains `backend/` and `mobile/` folders.
|
|
35
|
-
|
|
36
|
-
Run the same command from different folders:
|
|
37
|
-
|
|
38
|
-
```powershell
|
|
39
|
-
cd C:\Projects\my-app\backend
|
|
40
|
-
indraq prebuild # Docker/GitHub Packages/Jenkins/Route53/NPM
|
|
41
|
-
|
|
42
|
-
cd ..\mobile
|
|
43
|
-
indraq prebuild # Mobile Jenkins + OTA only
|
|
44
|
-
indraq build mobile:dev # Development build
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
From the project root, `indraq setup` walks through backend setup first, then mobile setup.
|
|
48
|
-
`indraq mobile prebuild --env immortility` always explicitly selects mobile setup.
|
|
49
|
-
Mobile build environments are separate from web deployment environments;
|
|
50
|
-
a Development mobile environment cannot run a Production build.
|
|
51
|
-
|
|
52
|
-
### Reuse an existing provider resource
|
|
53
|
-
|
|
54
|
-
When setting up a component, choose **Link existing** instead of **Create/reconcile**.
|
|
55
|
-
You can link existing GitHub container packages, Jenkins deployment jobs, Route53 A records, and NPM proxy hosts.
|
|
56
|
-
The CLI confirms the resource exists in the selected scope and saves the association.
|
|
57
|
-
A linked resource is not silently overwritten; retain its existing configuration.
|
|
58
|
-
Route53 record discovery needs manager/admin access; this is intentional.
|
|
59
|
-
|
|
60
|
-
### Safe permanent deletion
|
|
61
|
-
|
|
62
|
-
```powershell
|
|
63
|
-
indraq project delete
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
Select only the external resources you want removed; all default to **KEEP**.
|
|
67
|
-
The command now offers the exact provider scope when older projects have no scope link,
|
|
68
|
-
with MANAGE access required to delete external resources. For old GitHub Packages
|
|
69
|
-
scopes missing owner type, the CLI verifies the GitHub owner via GitHub's API
|
|
70
|
-
instead of guessing. Deleting a container package removes **all tags**.
|
|
71
|
-
Shared Jenkins mobile jobs, certificates, containers, and non-selected resources are not deleted.
|
|
72
|
-
If a deletion fails, the Cloud project is kept for retry.
|
|
73
|
-
|
|
74
|
-
**Upgrade:** Deploy Cloud API `1.3.0` before using CLI `2.7.1` deletion.
|
|
75
|
-
Use `npm install`, `npm run build`, `npm test`, and `npm publish --dry-run`
|
|
76
|
-
before publishing. Run the Cloud API build separately inside `cloud-api/`.
|
|
77
|
-
|
|
78
|
-
---
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
# Developer quick start — Web
|
|
82
|
-
|
|
83
|
-
## 1. Login once
|
|
84
|
-
|
|
85
|
-
```powershell
|
|
86
|
-
indraq login
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
Check your login:
|
|
90
|
-
|
|
91
|
-
```powershell
|
|
92
|
-
indraq whoami
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
Your login stays saved. You do not need to login before every build or deploy.
|
|
96
|
-
|
|
97
|
-
Revoke the persistent Cloud session when you want to sign out.
|
|
98
|
-
|
|
99
|
-
To logout and revoke the persistent Cloud session:
|
|
100
|
-
|
|
101
|
-
```powershell
|
|
102
|
-
indraq logout
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
---
|
|
106
|
-
|
|
107
|
-
## 2. Open your project folder
|
|
108
|
-
|
|
109
|
-
```powershell
|
|
110
|
-
cd C:\Projects\my-app
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
If the project is not in IndraQ yet:
|
|
114
|
-
|
|
115
|
-
```powershell
|
|
116
|
-
indraq project create
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
Choose your project type:
|
|
120
|
-
|
|
121
|
-
```text
|
|
122
|
-
Frontend
|
|
123
|
-
Backend
|
|
124
|
-
Frontend + Backend
|
|
125
|
-
User Frontend + Admin Frontend + Backend
|
|
126
|
-
Mobile App
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
For web projects, choose the server/environment where the app will run.
|
|
130
|
-
|
|
131
|
-
Then IndraQ shows **one setup list**:
|
|
132
|
-
|
|
133
|
-
```text
|
|
134
|
-
What do you want to configure for this project now?
|
|
135
|
-
|
|
136
|
-
[x] Dockerfile(s)
|
|
137
|
-
[x] GitHub Packages
|
|
138
|
-
[x] Jenkins
|
|
139
|
-
[ ] AWS Route53
|
|
140
|
-
[ ] Nginx Proxy Manager
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
Select what you want. IndraQ only starts the items you selected.
|
|
144
|
-
|
|
145
|
-
It does not keep asking:
|
|
146
|
-
|
|
147
|
-
```text
|
|
148
|
-
Would you like to configure it now?
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
for every item.
|
|
152
|
-
|
|
153
|
-
### What the setup items mean
|
|
154
|
-
|
|
155
|
-
| Option | What it does |
|
|
156
|
-
|---|---|
|
|
157
|
-
| Dockerfile(s) | Creates missing Docker files |
|
|
158
|
-
| GitHub Packages | Stores your Docker image at `ghcr.io` |
|
|
159
|
-
| Jenkins | Creates/repairs the Jenkins deploy pipeline |
|
|
160
|
-
| AWS Route53 | Creates/repairs DNS records |
|
|
161
|
-
| Nginx Proxy Manager | Creates/repairs the reverse proxy and SSL |
|
|
162
|
-
|
|
163
|
-
For a new Jenkins deployment, select **GitHub Packages + Jenkins** together.
|
|
164
|
-
|
|
165
|
-
Route53 and Nginx Proxy Manager run only when you select them.
|
|
166
|
-
|
|
167
|
-
---
|
|
168
|
-
|
|
169
|
-
## 3. Deploy
|
|
170
|
-
|
|
171
|
-
```powershell
|
|
172
|
-
indraq deploy
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
For a project with more than one part, choose what you want to deploy:
|
|
176
|
-
|
|
177
|
-
```text
|
|
178
|
-
All components
|
|
179
|
-
Frontend
|
|
180
|
-
Backend
|
|
181
|
-
Admin frontend
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
Enter an image tag, for example:
|
|
185
|
-
|
|
186
|
-
```text
|
|
187
|
-
latest
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
or:
|
|
191
|
-
|
|
192
|
-
```text
|
|
193
|
-
1.3.0
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
IndraQ will:
|
|
197
|
-
|
|
198
|
-
1. Check the project setup.
|
|
199
|
-
2. Check Dockerfiles.
|
|
200
|
-
3. Build the Docker image.
|
|
201
|
-
4. Push the image to GitHub Packages.
|
|
202
|
-
5. Start the Jenkins build.
|
|
203
|
-
6. Show the Jenkins logs in the terminal.
|
|
204
|
-
7. Wait for Jenkins to finish.
|
|
205
|
-
|
|
206
|
-
### If Dockerfile is missing
|
|
207
|
-
|
|
208
|
-
You do not need to stop and create it manually.
|
|
209
|
-
|
|
210
|
-
`indraq deploy` checks all selected components first.
|
|
211
|
-
|
|
212
|
-
If a Dockerfile is missing, it asks once:
|
|
213
|
-
|
|
214
|
-
```text
|
|
215
|
-
Generate the missing Dockerfile(s) now? Yes
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
Then deploy continues.
|
|
219
|
-
|
|
220
|
-
---
|
|
221
|
-
|
|
222
|
-
# Easy guided setup
|
|
223
|
-
|
|
224
|
-
If you are not sure which command to use, run:
|
|
225
|
-
|
|
226
|
-
```powershell
|
|
227
|
-
indraq setup
|
|
228
|
-
```
|
|
229
|
-
|
|
230
|
-
IndraQ will guide you through:
|
|
231
|
-
|
|
232
|
-
1. Login.
|
|
233
|
-
2. Project create/link.
|
|
234
|
-
3. Environment selection.
|
|
235
|
-
4. One setup list.
|
|
236
|
-
5. Only the items you select.
|
|
237
|
-
|
|
238
|
-
Use this command for first-time setup or repair.
|
|
239
|
-
|
|
240
|
-
---
|
|
241
|
-
|
|
242
|
-
# Prebuild
|
|
243
|
-
|
|
244
|
-
Use prebuild when you want to add or repair project services:
|
|
245
|
-
|
|
246
|
-
```powershell
|
|
247
|
-
indraq prebuild
|
|
248
|
-
```
|
|
249
|
-
|
|
250
|
-
You get one list:
|
|
251
|
-
|
|
252
|
-
```text
|
|
253
|
-
What should prebuild configure?
|
|
254
|
-
|
|
255
|
-
[ ] GitHub Packages
|
|
256
|
-
[ ] Jenkins
|
|
257
|
-
[ ] AWS Route53
|
|
258
|
-
[ ] Nginx Proxy Manager
|
|
259
|
-
```
|
|
260
|
-
|
|
261
|
-
Only selected items run.
|
|
262
|
-
|
|
263
|
-
For one environment:
|
|
264
|
-
|
|
265
|
-
```powershell
|
|
266
|
-
indraq prebuild --env production
|
|
267
|
-
```
|
|
268
|
-
|
|
269
|
-
For all project environments:
|
|
270
|
-
|
|
271
|
-
```powershell
|
|
272
|
-
indraq prebuild --all-targets
|
|
273
|
-
```
|
|
274
|
-
|
|
275
|
-
GitHub Packages + Jenkins only:
|
|
276
|
-
|
|
277
|
-
```powershell
|
|
278
|
-
indraq prebuild --required-only
|
|
279
|
-
```
|
|
280
|
-
|
|
281
|
-
---
|
|
282
|
-
|
|
283
|
-
# Multiple servers
|
|
284
|
-
|
|
285
|
-
A project can run on more than one server.
|
|
286
|
-
|
|
287
|
-
Choose the servers:
|
|
288
|
-
|
|
289
|
-
```powershell
|
|
290
|
-
indraq project environments
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
Example:
|
|
294
|
-
|
|
295
|
-
```text
|
|
296
|
-
prod-primary
|
|
297
|
-
prod-backup
|
|
298
|
-
```
|
|
299
|
-
|
|
300
|
-
Deploy one server:
|
|
301
|
-
|
|
302
|
-
```powershell
|
|
303
|
-
indraq deploy --env prod-primary
|
|
304
|
-
```
|
|
305
|
-
|
|
306
|
-
Deploy all configured servers:
|
|
307
|
-
|
|
308
|
-
```powershell
|
|
309
|
-
indraq deploy --all
|
|
310
|
-
```
|
|
311
|
-
|
|
312
|
-
IndraQ builds the image once and sends the **same exact image** to every selected Jenkins server.
|
|
313
|
-
|
|
314
|
-
---
|
|
315
|
-
|
|
316
|
-
# Jenkins build reliability
|
|
317
|
-
|
|
318
|
-
IndraQ v2.5.0 is safer when Jenkins or the reverse proxy is slow.
|
|
319
|
-
|
|
320
|
-
If Jenkins accepts the deploy request but the CLI temporarily gets a timeout or 502, IndraQ does **not** automatically send the same deploy again.
|
|
321
|
-
|
|
322
|
-
It tries to find the Jenkins build that was already started and continues following that build.
|
|
323
|
-
|
|
324
|
-
If IndraQ cannot safely find the build, it tells you to check Jenkins before retrying. This avoids duplicate deployments.
|
|
325
|
-
|
|
326
|
-
---
|
|
327
|
-
|
|
328
|
-
# GitHub Packages
|
|
329
|
-
|
|
330
|
-
The CLI now shows the name:
|
|
331
|
-
|
|
332
|
-
```text
|
|
333
|
-
GitHub Packages
|
|
334
|
-
```
|
|
335
|
-
|
|
336
|
-
Internally the Docker registry is still:
|
|
337
|
-
|
|
338
|
-
```text
|
|
339
|
-
ghcr.io
|
|
340
|
-
```
|
|
341
|
-
|
|
342
|
-
Developers do not need to remember the name `GHCR`.
|
|
343
|
-
|
|
344
|
-
---
|
|
345
|
-
|
|
346
|
-
# Web environment IPs
|
|
347
|
-
|
|
348
|
-
Admins create web environments with two IPs:
|
|
349
|
-
|
|
350
|
-
```text
|
|
351
|
-
External/Public IPv4
|
|
352
|
-
Internal/Private IPv4
|
|
353
|
-
```
|
|
354
|
-
|
|
355
|
-
They are used like this:
|
|
356
|
-
|
|
357
|
-
```text
|
|
358
|
-
AWS Route53 -> External/Public IPv4
|
|
359
|
-
Nginx Proxy Manager -> Internal/Private IPv4
|
|
360
|
-
```
|
|
361
|
-
|
|
362
|
-
Developers normally only select the environment name.
|
|
363
|
-
|
|
364
|
-
---
|
|
365
|
-
|
|
366
|
-
# Audit reasons
|
|
367
|
-
|
|
368
|
-
Normal creation/setup should stay quick.
|
|
369
|
-
|
|
370
|
-
IndraQ does **not** ask for an audit reason when creating or setting up new items such as:
|
|
371
|
-
|
|
372
|
-
- project creation
|
|
373
|
-
- environment creation
|
|
374
|
-
- provider scope creation
|
|
375
|
-
- mobile environment creation
|
|
376
|
-
- automatic setup/prebuild links
|
|
377
|
-
|
|
378
|
-
IndraQ writes a safe automatic reason for those actions.
|
|
379
|
-
|
|
380
|
-
IndraQ asks for a reason when you change or delete existing data, for example:
|
|
381
|
-
|
|
382
|
-
- update/delete an environment
|
|
383
|
-
- update/delete a user
|
|
384
|
-
- rename/delete a project
|
|
385
|
-
- archive/restore a project
|
|
386
|
-
- remove access
|
|
387
|
-
- rotate credentials
|
|
388
|
-
|
|
389
|
-
---
|
|
390
|
-
|
|
391
|
-
# Mobile quick start
|
|
392
|
-
|
|
393
|
-
IndraQ supports:
|
|
394
|
-
|
|
395
|
-
- Expo
|
|
396
|
-
- React Native CLI
|
|
397
|
-
|
|
398
|
-
Create a new mobile project:
|
|
399
|
-
|
|
400
|
-
```powershell
|
|
401
|
-
indraq init
|
|
402
|
-
```
|
|
403
|
-
|
|
404
|
-
Choose:
|
|
405
|
-
|
|
406
|
-
```text
|
|
407
|
-
Mobile App
|
|
408
|
-
```
|
|
409
|
-
|
|
410
|
-
Then choose:
|
|
411
|
-
|
|
412
|
-
```text
|
|
413
|
-
Expo
|
|
414
|
-
```
|
|
415
|
-
|
|
416
|
-
or:
|
|
417
|
-
|
|
418
|
-
```text
|
|
419
|
-
React Native CLI
|
|
420
|
-
```
|
|
421
|
-
|
|
422
|
-
For an existing mobile project:
|
|
423
|
-
|
|
424
|
-
```powershell
|
|
425
|
-
indraq project create
|
|
426
|
-
```
|
|
427
|
-
|
|
428
|
-
and select **Mobile App**.
|
|
429
|
-
|
|
430
|
-
---
|
|
431
|
-
|
|
432
|
-
# Mobile prebuild
|
|
433
|
-
|
|
434
|
-
Inside the mobile project:
|
|
435
|
-
|
|
436
|
-
```powershell
|
|
437
|
-
indraq prebuild
|
|
438
|
-
```
|
|
439
|
-
|
|
440
|
-
or:
|
|
441
|
-
|
|
442
|
-
```powershell
|
|
443
|
-
indraq mobile prebuild
|
|
444
|
-
```
|
|
445
|
-
|
|
446
|
-
Mobile prebuild configures only:
|
|
447
|
-
|
|
448
|
-
- Jenkins
|
|
449
|
-
- IndraQ OTA
|
|
450
|
-
|
|
451
|
-
It does not configure:
|
|
452
|
-
|
|
453
|
-
- Docker
|
|
454
|
-
- GitHub Packages
|
|
455
|
-
- AWS
|
|
456
|
-
- Route53
|
|
457
|
-
- Nginx Proxy Manager
|
|
458
|
-
|
|
459
|
-
---
|
|
460
|
-
|
|
461
|
-
# Mobile builds
|
|
462
|
-
|
|
463
|
-
Development:
|
|
464
|
-
|
|
465
|
-
```powershell
|
|
466
|
-
indraq build mobile:dev
|
|
467
|
-
```
|
|
468
|
-
|
|
469
|
-
Staging:
|
|
470
|
-
|
|
471
|
-
```powershell
|
|
472
|
-
indraq build mobile:staging
|
|
473
|
-
```
|
|
474
|
-
|
|
475
|
-
Production:
|
|
476
|
-
|
|
477
|
-
```powershell
|
|
478
|
-
indraq build mobile:prod
|
|
479
|
-
```
|
|
480
|
-
|
|
481
|
-
A successful native Jenkins build saves the app's native fingerprint in IndraQ Cloud. OTA is allowed only when the current app is compatible with that native build.
|
|
482
|
-
|
|
483
|
-
---
|
|
484
|
-
|
|
485
|
-
# OTA updates
|
|
486
|
-
|
|
487
|
-
OTA sends JavaScript and asset changes without publishing a new store build when native code did not change.
|
|
488
|
-
|
|
489
|
-
Backend:
|
|
490
|
-
|
|
491
|
-
```text
|
|
492
|
-
https://cli.indraq.com
|
|
493
|
-
```
|
|
494
|
-
|
|
495
|
-
OTA files are stored in MinIO.
|
|
496
|
-
|
|
497
|
-
## Send a test update
|
|
498
|
-
|
|
499
|
-
```powershell
|
|
500
|
-
indraq mobile send update --app "My App" --env production
|
|
501
|
-
```
|
|
502
|
-
|
|
503
|
-
You can target:
|
|
504
|
-
|
|
505
|
-
- installation ID
|
|
506
|
-
- user ID
|
|
507
|
-
- username
|
|
508
|
-
- email
|
|
509
|
-
- phone
|
|
510
|
-
- percentage of users
|
|
511
|
-
- everyone
|
|
512
|
-
|
|
513
|
-
The app checks for an OTA update when the app starts. If an update is found, it downloads it and reloads before the user starts normal work.
|
|
514
|
-
|
|
515
|
-
## Release the same tested update to everyone
|
|
516
|
-
|
|
517
|
-
```powershell
|
|
518
|
-
indraq mobile release update --app "My App"
|
|
519
|
-
```
|
|
520
|
-
|
|
521
|
-
IndraQ does not rebuild the bundle. It releases the same bundle you already tested.
|
|
522
|
-
|
|
523
|
-
## Metrics
|
|
524
|
-
|
|
525
|
-
```powershell
|
|
526
|
-
indraq mobile metrics --app "My App"
|
|
527
|
-
```
|
|
528
|
-
|
|
529
|
-
## Pause an update
|
|
530
|
-
|
|
531
|
-
```powershell
|
|
532
|
-
indraq mobile pause --app "My App"
|
|
533
|
-
```
|
|
534
|
-
|
|
535
|
-
## Roll back
|
|
536
|
-
|
|
537
|
-
```powershell
|
|
538
|
-
indraq mobile rollback --app "My App"
|
|
539
|
-
```
|
|
540
|
-
|
|
541
|
-
---
|
|
542
|
-
|
|
543
|
-
# Admin commands
|
|
544
|
-
|
|
545
|
-
Developers normally do not need this section.
|
|
546
|
-
|
|
547
|
-
## Web environments
|
|
548
|
-
|
|
549
|
-
Create:
|
|
550
|
-
|
|
551
|
-
```powershell
|
|
552
|
-
indraq environment create
|
|
553
|
-
```
|
|
554
|
-
|
|
555
|
-
List:
|
|
556
|
-
|
|
557
|
-
```powershell
|
|
558
|
-
indraq environment list
|
|
559
|
-
```
|
|
560
|
-
|
|
561
|
-
Update:
|
|
562
|
-
|
|
563
|
-
```powershell
|
|
564
|
-
indraq environment update <name>
|
|
565
|
-
```
|
|
566
|
-
|
|
567
|
-
Delete:
|
|
568
|
-
|
|
569
|
-
```powershell
|
|
570
|
-
indraq environment delete <name>
|
|
571
|
-
```
|
|
572
|
-
|
|
573
|
-
## Mobile environments
|
|
574
|
-
|
|
575
|
-
Create:
|
|
576
|
-
|
|
577
|
-
```powershell
|
|
578
|
-
indraq mobile environment create
|
|
579
|
-
```
|
|
580
|
-
|
|
581
|
-
List:
|
|
582
|
-
|
|
583
|
-
```powershell
|
|
584
|
-
indraq mobile environment list
|
|
585
|
-
```
|
|
586
|
-
|
|
587
|
-
## Provider connections
|
|
588
|
-
|
|
589
|
-
Create a provider connection:
|
|
590
|
-
|
|
591
|
-
```powershell
|
|
592
|
-
indraq scope create
|
|
593
|
-
```
|
|
594
|
-
|
|
595
|
-
Provider names shown in the CLI:
|
|
596
|
-
|
|
597
|
-
```text
|
|
598
|
-
AWS
|
|
599
|
-
Nginx Proxy Manager
|
|
600
|
-
Jenkins Development
|
|
601
|
-
Jenkins Production
|
|
602
|
-
GitHub Packages
|
|
603
|
-
```
|
|
604
|
-
|
|
605
|
-
List them:
|
|
606
|
-
|
|
607
|
-
```powershell
|
|
608
|
-
indraq scope list
|
|
609
|
-
```
|
|
610
|
-
|
|
611
|
-
## Users
|
|
612
|
-
|
|
613
|
-
Create a user:
|
|
614
|
-
|
|
615
|
-
```powershell
|
|
616
|
-
indraq user create
|
|
617
|
-
```
|
|
618
|
-
|
|
619
|
-
List users:
|
|
620
|
-
|
|
621
|
-
```powershell
|
|
622
|
-
indraq user list
|
|
623
|
-
```
|
|
624
|
-
|
|
625
|
-
When IndraQ creates a Nginx Proxy Manager user, it now tests that user's email/password login before reporting success.
|
|
626
|
-
|
|
627
|
-
---
|
|
628
|
-
|
|
629
|
-
# Common commands
|
|
630
|
-
|
|
631
|
-
| Task | Command |
|
|
632
|
-
|---|---|
|
|
633
|
-
| Login | `indraq login` |
|
|
634
|
-
| Check login | `indraq whoami` |
|
|
635
|
-
| Guided setup | `indraq setup` |
|
|
636
|
-
| Create project | `indraq project create` |
|
|
637
|
-
| Project status | `indraq project status` |
|
|
638
|
-
| Choose project servers | `indraq project environments` |
|
|
639
|
-
| Configure project services | `indraq prebuild` |
|
|
640
|
-
| Deploy web app | `indraq deploy` |
|
|
641
|
-
| Create Dockerfile | `indraq dockerfile create` |
|
|
642
|
-
| List environments | `indraq environment list` |
|
|
643
|
-
| List provider connections | `indraq scope list` |
|
|
644
|
-
| Create user | `indraq user create` |
|
|
645
|
-
| Run Jenkins pipeline | `indraq jenkins run` |
|
|
646
|
-
| Mobile prebuild | `indraq mobile prebuild` |
|
|
647
|
-
| Mobile production build | `indraq build mobile:prod` |
|
|
648
|
-
| Send OTA | `indraq mobile send update --app "My App"` |
|
|
649
|
-
| OTA metrics | `indraq mobile metrics --app "My App"` |
|
|
650
|
-
| Main help | `indraq --help` |
|
|
651
|
-
| Topic help | `indraq help project` |
|
|
652
|
-
|
|
653
|
-
---
|
|
654
|
-
|
|
655
|
-
# Troubleshooting
|
|
656
|
-
|
|
657
|
-
## Dockerfile is missing
|
|
658
|
-
|
|
659
|
-
Run:
|
|
660
|
-
|
|
661
|
-
```powershell
|
|
662
|
-
indraq deploy
|
|
663
|
-
```
|
|
664
|
-
|
|
665
|
-
and choose **Yes** when IndraQ offers to create the missing Dockerfile(s).
|
|
666
|
-
|
|
667
|
-
Or run:
|
|
668
|
-
|
|
669
|
-
```powershell
|
|
670
|
-
indraq dockerfile create
|
|
671
|
-
```
|
|
672
|
-
|
|
673
|
-
## Jenkins looks stuck
|
|
674
|
-
|
|
675
|
-
Do not immediately run deploy again.
|
|
676
|
-
|
|
677
|
-
IndraQ v2.5.0 tries to reconnect to the same Jenkins build.
|
|
678
|
-
|
|
679
|
-
If IndraQ says the result is uncertain, open Jenkins and check whether the build started before retrying.
|
|
680
|
-
|
|
681
|
-
## Nginx Proxy Manager gives 401 for a user
|
|
682
|
-
|
|
683
|
-
New users created with v2.5.0 are tested during creation.
|
|
684
|
-
|
|
685
|
-
For an old user, rotate/recreate the NPM user credential. IndraQ uses the user's **email address** as the NPM login identity.
|
|
686
|
-
|
|
687
|
-
## Need Route53 or NPM after project creation
|
|
688
|
-
|
|
689
|
-
Run:
|
|
690
|
-
|
|
691
|
-
```powershell
|
|
692
|
-
indraq prebuild
|
|
693
|
-
```
|
|
694
|
-
|
|
695
|
-
Select only the missing item.
|
|
696
|
-
|
|
697
|
-
## Need a full setup/repair
|
|
698
|
-
|
|
699
|
-
Run:
|
|
700
|
-
|
|
701
|
-
```powershell
|
|
702
|
-
indraq setup
|
|
703
|
-
```
|
|
704
|
-
|
|
705
|
-
---
|
|
706
|
-
|
|
707
|
-
# Cloud API development
|
|
708
|
-
|
|
709
|
-
The Cloud API has its own npm dependencies.
|
|
710
|
-
|
|
711
|
-
From the repository root:
|
|
712
|
-
|
|
713
|
-
```powershell
|
|
714
|
-
cd cloud-api
|
|
715
|
-
npm install
|
|
716
|
-
npm run build
|
|
717
|
-
npm run dev
|
|
718
|
-
```
|
|
719
|
-
|
|
720
|
-
Running `npm install` in the root folder does not install `cloud-api` dependencies.
|
|
721
|
-
|
|
722
|
-
Cloud API environment settings are in:
|
|
723
|
-
|
|
724
|
-
```text
|
|
725
|
-
cloud-api/.env.example
|
|
726
|
-
```
|
|
727
|
-
|
|
728
|
-
---
|
|
729
|
-
|
|
730
|
-
# Before publishing the CLI
|
|
731
|
-
|
|
732
|
-
From the repository root:
|
|
733
|
-
|
|
734
|
-
```powershell
|
|
735
|
-
npm install
|
|
736
|
-
npm run build
|
|
737
|
-
npm test
|
|
738
|
-
npm publish --dry-run
|
|
739
|
-
```
|
|
740
|
-
|
|
741
|
-
Then:
|
|
742
|
-
|
|
743
|
-
```powershell
|
|
744
|
-
npm publish
|
|
745
|
-
```
|
|
746
|
-
|
|
747
|
-
---
|
|
748
|
-
|
|
749
|
-
**IndraQ Innovations — IndraQ CLI v2.7.1**
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
---
|
|
753
|
-
|
|
754
|
-
# What is new in v2.6.0
|
|
755
|
-
|
|
756
|
-
## Backend + Mobile App
|
|
757
|
-
|
|
758
|
-
Choose **Backend + Mobile App** under `indraq init` or `indraq project create`.
|
|
759
|
-
The backend lives in `backend/` and uses normal Docker, GitHub Packages, Jenkins,
|
|
760
|
-
Route53, and NPM provisioning. The mobile app lives in `mobile/` and uses
|
|
761
|
-
Jenkins native builds and IndraQ OTA. `indraq setup` configures both once.
|
|
762
|
-
|
|
763
|
-
## Project deletion cleanup
|
|
764
|
-
|
|
765
|
-
`indraq project delete` lists the actual resources linked to the project and
|
|
766
|
-
asks which to delete: Route53 A records, GitHub Packages container packages,
|
|
767
|
-
project-specific Jenkins jobs, and NPM proxy hosts. **Everything starts as KEEP.**
|
|
768
|
-
Shared resources and the shared mobile Jenkins pipeline are protected.
|
|
769
|
-
An external resource marked as linked requires extra approval to delete.
|
|
770
|
-
If any chosen provider deletion fails, the Cloud project stays available for retry.
|
|
771
|
-
Deleting GitHub Packages removes all tags and versions of the selected package.
|
|
772
|
-
AWS health checks, NPM certificates, running containers, and local source files
|
|
773
|
-
are not automatically deleted. `--yes` does not select any resources automatically.
|
|
774
|
-
|
|
775
|
-
## Windows OTA signing fix
|
|
776
|
-
|
|
777
|
-
`expo-updates codesigning:generate` now uses a Windows-safe argument-preserving
|
|
778
|
-
`npx` launcher. Temporary private key material is cleaned up after errors too.
|