mokxi adalah tool command line kecil tanpa dependensi lain. Butuh Node.js 18 atau lebih baru. Jalankan dengan npx @mokxi/cli, atau pasang sekali dengan npm install -g @mokxi/cli.
Masuk
npx @mokxi/cli login
It shows a short code and opens mokxi.com/device. Setujui di sana, lalu tool mendapat token miliknya sendiri. Untuk menempelkan token yang kamu buat di
Settings > Developer instead, run npx @mokxi/cli login --paste.
Token disimpan di folder konfigurasi user kamu (~/.config/mokxi/config.json, atau di bawah XDG_CONFIG_HOME), hanya bisa dibaca oleh kamu. npx @mokxi/cli logout menghapusnya; cabut token di Pengaturan > Developer saat kamu sudah selesai memakainya.
Perintah
| Perintah | Fungsinya |
|---|---|
mokxi list |
proyek kamu, beserta id-nya |
mokxi new <board> [dir] |
memulai proyek untuk sebuah board, misalnya mokxi new uno blink |
mokxi pull <id or link> [dir] |
menulis proyek sebagai file (lihat di bawah) |
mokxi pull |
di dalam folder hasil pull: mengambil versi terbaru |
mokxi push [dir] |
mengirim folder ke Mokxi, membuat proyeknya pada kali pertama |
mokxi run [dir] [--timeout 10s] |
mengompilasi dan menjalankannya di mesin kamu sendiri serta mencetak keluaran serial saat datang |
mokxi test [dir] |
menjalankan scenario mokxi.test.yaml milik folder dan melaporkan masing-masing |
mokxi run --cloud [dir] |
menjalankannya di server Mokxi |
mokxi open [dir or id] |
membuka proyeknya di browser kamu |
mokxi upload [dir] --firmware FILE |
menyimpan sebuah build (arduino-cli .elf) bersama proyek |
mokxi boards |
board yang disimulasi Mokxi |
mokxi --help mencantumkan semua opsi.
File-file-nya
mokxi pull menulis layout yang sama dengan Simpan ke GitHub di editor: sketch sebagai folder Arduino IDE (Blink/Blink.ino beserta tabnya), seluruh proyek sebagai diagram.mokxi.json, sebuah README dengan badge Open in Mokxi, serta pengaturan dan task .vscode/. Lihat Mokxi, VS Code dan GitHub untuk penjelasan tiap file.
Jadi awalan yang biasa adalah:
npx @mokxi/cli pull https://mokxi.com/p/abc123 blink
cd blink
git init && git add . && git commit -m "From Mokxi"
Lalu edit, npx @mokxi/cli push, dan commit seperti biasa pada kode apa pun. Clone dari repositori menemukan proyeknya di .vscode/settings.json, jadi mokxi push juga berfungsi di sana.
Sinkronisasi yang aman
.mokxi/project.json mengingat apa yang terakhir disinkronkan (ada di .gitignore).
mokxi pushmenolak saat proyek berubah di Mokxi sejak pull atau push terakhirmu, jadi tidak pernah menimpa pekerjaan yang dilakukan di browser.--forcetetap menimpa.mokxi pullmenolak saat kamu mengubah file yang belum kamu push.--forcemenggantinya.- Tab yang dihapus di Mokxi akan dihapus dari folder pada pull berikutnya, kecuali kamu mengubah file itu.
mokxi push --new membuat proyek baru dari folder alih-alih memperbarui proyek asalnya.
Menjalankan
mokxi run mengompilasi sketch dengan compiler yang sama seperti editor dan menjalankannya di simulator yang sama, di mesin kamu sendiri. Tidak butuh akun dan gratis: compiler diunduh sekali (sekitar 80 MB) dan disimpan di folder cache. Sebuah folder bisa berupa proyek Mokxi hasil pull, proyek Wokwi dengan diagram.json dan wokwi.toml-nya, atau sketch Arduino biasa.
npx @mokxi/cli run --timeout 10s --expect-serial "Ready" --fail-on "panic"
Test itu lulus begitu sketch mencetak Ready, gagal saat mencetak panic, dan keluar dengan kode 1 jika 10 detik waktu simulasi berlalu lebih dulu, sesuai yang diinginkan job CI. mokxi test menjalankan file scenario yang menekan tombol, memutar sensor, dan memeriksa pin serta LED. Panduan Simulasi tes di CI membahas semuanya, lengkap dengan GitHub Action.
mokxi run --cloud menjalankan di server Mokxi sebagai gantinya, dan dihitung terhadap menit API paketmu. Selama folder sesuai dengan sinkronisasi terakhir, tool menjalankan proyek yang tersimpan, termasuk build yang disimpan editor setelah kamu menekan Jalankan. Dengan perubahan lokal tool mengirim file folder, dan server Mokxi tidak mengompilasi: build dengan arduino-cli dan berikan --firmware build/Blink/Blink.ino.elf, atau push dan tekan Jalankan di editor sekali. run --cloud memakai pemeriksaan yang sama dengan mokxi simulate.
Batasan paket
Push proyek baru dihitung terhadap batas proyek paketmu seperti proyek lainnya. Saat kamu mencapainya, mokxi push mencetak pesan yang sama seperti yang ditampilkan editor, dan keluar dengan 3.
Kode keluar
0 saat semuanya berhasil, 1 saat sebuah run gagal dalam pemeriksaan (atau waktu habis, atau gagal dikompilasi), 2 untuk kesalahan pada perintah, dan 3 saat Mokxi menolak (sudah keluar, batas paket, konflik) atau unduhan gagal.