mokxi là một công cụ dòng lệnh nhỏ, không phụ thuộc gì khác. Nó cần Node.js 18 trở lên. Chạy bằng npx @mokxi/cli, hoặc cài một lần với npm install -g @mokxi/cli.
Đăng nhập
npx @mokxi/cli login
It shows a short code and opens mokxi.com/device. Phê duyệt ở đó, và công cụ sẽ nhận mã token riêng của nó. Để dán một token bạn đã tạo trong
Settings > Developer instead, run npx @mokxi/cli login --paste.
Token được lưu trong thư mục cấu hình của người dùng (~/.config/mokxi/config.json, hoặc dưới XDG_CONFIG_HOME), chỉ bạn mới đọc được. npx @mokxi/cli logout sẽ xóa nó; thu hồi token trong Settings > Developer khi không còn dùng nữa.
Lệnh
| Lệnh | Công dụng |
|---|---|
mokxi list |
các dự án của bạn, kèm id của chúng |
mokxi new <board> [dir] |
tạo một dự án cho một bo mạch, ví dụ mokxi new uno blink |
mokxi pull <id or link> [dir] |
ghi dự án ra thành các tệp (xem bên dưới) |
mokxi pull |
trong một thư mục đã pull: lấy bản mới nhất |
mokxi push [dir] |
gửi thư mục lên Mokxi, tạo dự án ở lần đầu tiên |
mokxi run [dir] [--timeout 10s] |
biên dịch và chạy ngay trên máy của bạn, in ra serial output khi có |
mokxi test [dir] |
chạy các scenario mokxi.test.yaml của thư mục và báo cáo từng cái |
mokxi run --cloud [dir] |
chạy trên máy chủ của Mokxi thay vì máy bạn |
mokxi open [dir or id] |
mở dự án trong trình duyệt của bạn |
mokxi upload [dir] --firmware FILE |
lưu một bản biên dịch (tệp .elf của arduino-cli) cùng dự án |
mokxi boards |
các bo mạch mà Mokxi mô phỏng |
mokxi --help liệt kê mọi tùy chọn.
Các tệp
mokxi pull ghi ra bố cục giống Lưu lên GitHub trong trình soạn thảo: sketch dạng thư mục Arduino IDE (Blink/Blink.ino và các tab của nó), toàn bộ dự án thành diagram.mokxi.json, một README kèm huy hiệu Open in Mokxi, cùng cài đặt và tác vụ trong .vscode/. Xem Mokxi, VS Code và GitHub để biết mỗi tệp là gì.
Vậy một khởi đầu điển hình là:
npx @mokxi/cli pull https://mokxi.com/p/abc123 blink
cd blink
git init && git add . && git commit -m "From Mokxi"
Sau đó chỉnh sửa, npx @mokxi/cli push, và commit như với bất kỳ đoạn code nào. Bản sao của kho lưu trữ tìm thấy dự án trong .vscode/settings.json, nên mokxi push cũng chạy được ở đó.
Đồng bộ an toàn
.mokxi/project.json ghi nhớ lần đồng bộ gần nhất (nó nằm trong .gitignore).
mokxi pushtừ chối khi dự án đã thay đổi trên Mokxi kể từ lần pull hoặc push gần nhất của bạn, nên nó không bao giờ ghi đè công việc làm trong trình duyệt.--forcevẫn ghi đè.mokxi pulltừ chối khi bạn đã thay đổi các tệp chưa push.--forcesẽ thay thế chúng.- Một tab bị xóa trên Mokxi sẽ bị xóa khỏi thư mục ở lần pull tiếp theo, trừ khi bạn đã thay đổi tệp đó.
mokxi push --new tạo một dự án mới từ thư mục thay vì cập nhật dự án gốc.
Chạy
mokxi run biên dịch sketch bằng chính trình biên dịch mà trình soạn thảo dùng và chạy trên chính trình mô phỏng đó, ngay trên máy của bạn. Nó không cần tài khoản và hoàn toàn miễn phí: trình biên dịch được tải một lần (khoảng 80 MB) và giữ trong thư mục cache. Một thư mục có thể là dự án Mokxi đã pull, một dự án Wokwi với diagram.json và wokwi.toml, hoặc một sketch Arduino thông thường.
npx @mokxi/cli run --timeout 10s --expect-serial "Ready" --fail-on "panic"
Kiểm tra đó đạt ngay khi sketch in ra Ready, lỗi ngay khi in ra panic, và thoát với mã 1 nếu 10 giây thời gian mô phỏng trôi qua trước đó, đúng như một job CI cần. mokxi test chạy các tệp kịch bản để nhấn nút, xoay cảm biến và kiểm tra các chân và LED. Kiểm thử mô phỏng trong CI có đầy đủ thông tin, kèm một GitHub Action.
mokxi run --cloud chạy trên máy chủ của Mokxi thay vì máy bạn, và tính vào số phút API của gói bạn. Khi thư mục trùng với lần đồng bộ gần nhất, nó chạy dự án đã lưu, kể cả bản biên dịch mà trình soạn thảo giữ sau khi bạn nhấn Chạy. Khi có thay đổi cục bộ, nó gửi các tệp của thư mục, và máy chủ Mokxi không biên dịch: hãy biên dịch bằng arduino-cli và truyền --firmware build/Blink/Blink.ino.elf, hoặc push rồi nhấn Chạy trong trình soạn thảo một lần. run --cloud áp dụng các kiểm tra giống mokxi simulate.
Giới hạn của gói
Push một dự án mới tính vào giới hạn dự án của gói bạn như mọi dự án khác. Khi chạm giới hạn, mokxi push in ra thông điệp giống trình soạn thảo hiển thị, và thoát với mã 3.
Mã thoát
0 khi mọi thứ hoạt động, 1 khi một lần chạy không đạt kiểm tra (hoặc hết thời gian chờ, hoặc không biên dịch được), 2 khi lệnh bị sai, và 3 khi Mokxi từ chối (chưa đăng nhập, chạm giới hạn gói, xung đột) hoặc một lượt tải xuống thất bại.