Cuentas y planes

La línea de comandos de mokxi

Guarda un proyecto en una carpeta propia, sincronízalo con Mokxi y ejecútalo desde una terminal.

mokxi es una herramienta de línea de comandos pequeña, sin otras dependencias. Necesita Node.js 18 o más reciente. Ejecútala con npx @mokxi/cli, o instálala una vez con npm install -g @mokxi/cli.

Entrar

npx @mokxi/cli login

It shows a short code and opens mokxi.com/device. Apruébalo ahí, y la herramienta recibe un token propio. Para pegar un token que hayas creado en Settings > Developer instead, run npx @mokxi/cli login --paste.

El token se guarda en la carpeta de configuración de tu usuario (~/.config/mokxi/config.json, o bajo XDG_CONFIG_HOME), legible solo por ti. npx @mokxi/cli logout lo olvida; revócalo en Configuración > Developer cuando termines de usarlo.

Comandos

Comando Qué hace
mokxi list tus proyectos, con sus ids
mokxi new <board> [dir] crea un proyecto para una placa, por ejemplo mokxi new uno blink
mokxi pull <id or link> [dir] escribe el proyecto como archivos (ver abajo)
mokxi pull dentro de una carpeta descargada: obtiene lo más reciente
mokxi push [dir] envía la carpeta a Mokxi, creando el proyecto la primera vez
mokxi run [dir] [--timeout 10s] lo compila y ejecuta en tu propia máquina e imprime la salida serie a medida que llega
mokxi test [dir] ejecuta los escenarios mokxi.test.yaml de la carpeta e informa sobre cada uno
mokxi run --cloud [dir] lo ejecuta en los servidores de Mokxi
mokxi open [dir or id] abre el proyecto en tu navegador
mokxi upload [dir] --firmware FILE guarda una compilación (un .elf de arduino-cli) con el proyecto
mokxi boards las placas que Mokxi simula

mokxi --help lista todas las opciones.

Los archivos

mokxi pull escribe la misma estructura que Guardar en GitHub en el editor: el sketch como una carpeta del IDE de Arduino (Blink/Blink.ino y sus pestañas), el proyecto completo como diagram.mokxi.json, un README con una marca de Abrir en Mokxi, y la configuración y tareas de .vscode/. Mira Mokxi, VS Code y GitHub para saber qué es cada archivo.

Así que un inicio típico es:

npx @mokxi/cli pull https://mokxi.com/p/abc123 blink
cd blink
git init && git add . && git commit -m "From Mokxi"

Luego edita, npx @mokxi/cli push, y haz commit como con cualquier código. Un clon del repositorio encuentra su proyecto en .vscode/settings.json, así que mokxi push también funciona ahí.

Sincronización segura

.mokxi/project.json recuerda qué se sincronizó por última vez (está en .gitignore).

  • mokxi push se niega cuando el proyecto cambió en Mokxi desde tu última descarga o subida, así que nunca sobrescribe el trabajo hecho en el navegador. --force lo sobrescribe de todos modos.
  • mokxi pull se niega cuando cambiaste archivos que aún no has subido. --force los reemplaza.
  • Una pestaña eliminada en Mokxi se elimina de la carpeta en la siguiente descarga, salvo que hayas cambiado ese archivo.

mokxi push --new crea un proyecto nuevo a partir de la carpeta, en lugar de actualizar el de donde vino.

Ejecución

mokxi run compila el sketch con el mismo compilador que usa el editor y lo ejecuta en el mismo simulador, en tu propia máquina. No necesita cuenta y no cuesta nada: el compilador se descarga una vez (unos 80 MB) y se guarda en una carpeta de caché. Una carpeta puede ser un proyecto de Mokxi descargado, un proyecto de Wokwi con su diagram.json y wokwi.toml, o un sketch de Arduino normal.

npx @mokxi/cli run --timeout 10s --expect-serial "Ready" --fail-on "panic"

Eso pasa en cuanto el sketch imprime Ready, falla en el momento en que imprime panic, y sale con 1 si pasan primero 10 segundos de tiempo simulado, que es lo que quiere un trabajo de CI. mokxi test ejecuta archivos de escenarios que presionan botones, giran sensores y revisan pines y LEDs. Pruebas de simulación en CI tiene todo, con una GitHub Action.

mokxi run --cloud se ejecuta en los servidores de Mokxi, y cuenta para los minutos de API de tu plan. Mientras la carpeta coincida con lo último sincronizado, ejecuta el proyecto guardado, incluida la compilación que el editor conserva después de presionar Ejecutar. Con cambios locales envía los archivos de la carpeta, y los servidores de Mokxi no compilan: compila con arduino-cli y pasa --firmware build/Blink/Blink.ino.elf, o sube y presiona Ejecutar en el editor una vez. run --cloud acepta las mismas verificaciones que mokxi simulate.

Límites del plan

Subir un proyecto nuevo cuenta para el límite de proyectos de tu plan como cualquier otro proyecto. Cuando llegas al límite, mokxi push imprime el mismo mensaje que muestra el editor, y sale con 3.

Códigos de salida

0 cuando todo funcionó, 1 cuando una ejecución falló una verificación (o se agotó el tiempo, o no compiló), 2 por un error en el comando, y 3 cuando Mokxi dijo no (sesión cerrada, un límite del plan, un conflicto) o falló una descarga.