@vention/vention-cli 0.38.15 → 0.38.17
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 +27 -1
- package/main.esm.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# Vention CLI
|
|
2
2
|
|
|
3
|
+
> **⚠️ Upgrade required.** Vention CLI 0.37.0 or later is required to pull, push and read logs for your MachineLogic Python apps. Older versions report your design as not open. Run `npm install -g @vention/vention-cli@latest`, then `vention login`. See [Upgrade](#upgrade).
|
|
4
|
+
|
|
3
5
|
> A command-line tool that enables local development of MachineLogic Python applications with bidirectional sync between your IDE and MachineBuilder.
|
|
4
6
|
|
|
5
7
|
---
|
|
@@ -9,6 +11,7 @@
|
|
|
9
11
|
- [✨ Features](#-features)
|
|
10
12
|
- [🧠 Concepts & Overview](#-concepts--overview)
|
|
11
13
|
- [⚙️ Installation & Setup](#-installation--setup)
|
|
14
|
+
- [Upgrade](#upgrade)
|
|
12
15
|
- [🚀 Quickstart Tutorial](#-quickstart-tutorial)
|
|
13
16
|
- [🛠 How-to Guides](#-how-to-guides)
|
|
14
17
|
- [📖 API Reference](#-api-reference)
|
|
@@ -64,9 +67,12 @@ OAuth-based authentication opens a browser window for secure login. Session toke
|
|
|
64
67
|
- Node.js 18 or higher
|
|
65
68
|
- npm or yarn
|
|
66
69
|
- Active MachineBuilder session with MachineLogic tab open
|
|
70
|
+
- Vention CLI 0.37.0 or later to pull, push and read logs for your MachineLogic Python apps (see [Upgrade](#upgrade))
|
|
67
71
|
|
|
68
72
|
**Install globally via npm:**
|
|
69
73
|
|
|
74
|
+
The CLI is published on npm as [`@vention/vention-cli`](https://www.npmjs.com/package/@vention/vention-cli).
|
|
75
|
+
|
|
70
76
|
```bash
|
|
71
77
|
npm install -g @vention/vention-cli
|
|
72
78
|
```
|
|
@@ -85,6 +91,18 @@ Use either `vention` or `vn` as the command prefix.
|
|
|
85
91
|
**Learn more about MachineLogic Python app structure:**
|
|
86
92
|
https://docs.vention.com/docs/machinelogic-python-programming-guide
|
|
87
93
|
|
|
94
|
+
### Upgrade
|
|
95
|
+
|
|
96
|
+
Install the latest version, check it, then log in again:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
npm install -g @vention/vention-cli@latest
|
|
100
|
+
vention --version
|
|
101
|
+
vention login
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
`npm update -g` can leave you on an older version, because npm pins globally installed packages to a caret range. Always use the command above.
|
|
105
|
+
|
|
88
106
|
---
|
|
89
107
|
|
|
90
108
|
## 🚀 Quickstart Tutorial
|
|
@@ -399,11 +417,16 @@ vention skills status
|
|
|
399
417
|
- **Cause:** Authentication tokens not found or expired
|
|
400
418
|
- **Solution:** Run `vention login` to re-authenticate
|
|
401
419
|
|
|
402
|
-
**"No active
|
|
420
|
+
**"No active allocations found …" or "Sorry, it seems you do not have that design open …"**
|
|
403
421
|
|
|
404
422
|
- **Cause:** No designs have the MachineLogic tab open in MachineBuilder
|
|
405
423
|
- **Solution:** Open your target design in MachineBuilder and click the MachineLogic tab to activate it
|
|
406
424
|
|
|
425
|
+
**The same two messages although the design is open with the MachineLogic tab**
|
|
426
|
+
|
|
427
|
+
- **Cause:** The CLI is older than 0.37.0. Older versions can no longer reach your MachineLogic Python apps, so they report the design as not open.
|
|
428
|
+
- **Solution:** Run `vention --version`. Below 0.37.0, follow [Upgrade](#upgrade) and retry. At 0.37.0 or later, contact Vention support with the output of the failing command run with `vention --verbose`.
|
|
429
|
+
|
|
407
430
|
**"This directory is not linked …"**
|
|
408
431
|
|
|
409
432
|
- **Cause:** The directory doesn't have `.machine-code-app-directory-info.json`
|
|
@@ -433,6 +456,9 @@ A: No, you only need MachineBuilder open (with MachineLogic tab active) when run
|
|
|
433
456
|
**Q: Where are my authentication tokens stored?**
|
|
434
457
|
A: In `~/.vention-cli-config.json` in your home directory.
|
|
435
458
|
|
|
459
|
+
**Q: How do I check my CLI version and upgrade?**
|
|
460
|
+
A: `vention --version` prints it. See [Upgrade](#upgrade) for the one-line upgrade command.
|
|
461
|
+
|
|
436
462
|
**Q: Can I work on multiple apps simultaneously?**
|
|
437
463
|
A: Yes, each app folder maintains its own link metadata. You can have multiple linked directories.
|
|
438
464
|
|
package/main.esm.js
CHANGED