Saltar al contenido principal
Midaz CLI (Interfaz de Línea de Comandos) es una herramienta poderosa para interactuar con los servicios y APIs de la plataforma Midaz a través de la línea de comandos. Soporta operaciones como crear, listar, editar y eliminar entidades como Ledgers, Organizaciones y Divisions, proporcionando a los usuarios un control eficiente sobre sus flujos de trabajo. Diseñado con funcionalidad y simplicidad en mente, el CLI se autodocumenta. Al usar la bandera --help, puedes acceder instantáneamente a una lista de comandos disponibles y su uso, asegurando una experiencia de usuario intuitiva.
NotaMidaz CLI aún está en desarrollo. Para más información, contáctanos.

​
Formato de color y tipo

Midaz CLI utiliza un sistema visual intuitivo para mejorar la legibilidad y apoyar a usuarios con diferentes niveles de experiencia en CLI. Estas convenciones incluyen lo siguiente:
  • Entidades e IDs
    • Los tipos de entidades (Ledger, Organización y Divisions) se muestran en azul y negrita.
    • Los IDs se muestran en rosa y negrita.
  • Métodos HTTP
    • POST: Se muestra en amarillo y negrita.
    • DELETE: Se muestra en rojo y negrita.
    • PUT y PATCH: Se muestran en azul y negrita.
    • GET: Se muestra en verde y negrita.
Ejemplo

Figura 1. Un ejemplo de una Organización creada usando Midaz CLI.

​
Espaciado

Todo el texto mostrado sigue espaciado simple para asegurar una presentación limpia.

​
Iconografía

  • ✔: Indica una operación exitosa.
  • ✕: Indica una operación fallida.

​
Modos de uso

Midaz CLI soporta tres modos de uso principales:

​
Comandos de una sola línea

Si deseas usar comandos de una sola línea, puedes pasar todos los parámetros requeridos directamente en el comando (figura 2).

Figura 2. Ejemplo de un comando de una sola línea.

​
Modo interactivo

En modo interactivo, completarás la solicitud como si fuera un formulario. Los parámetros requeridos se solicitarán uno a la vez (figura 3).

Figura 3. Ejemplo del modo interactivo.

AtenciónEn modo interactivo, solo se solicitarán los campos requeridos. Si deseas usar los campos opcionales, usa el comando de una sola línea.

​
Modo de ayuda

Si necesitas asistencia con cualquier comando o subcomando, puedes usar las opciones --help o -h al final del comando. Esto mostrará información como una descripción, ejemplos y opciones disponibles para ese comando (figura 4).

Figura 4. Ejemplo del modo de ayuda.

​
Configuración de Midaz CLI

Si es necesario, puedes usar el comando mdz configure para definir los siguientes parámetros según los valores que uses para tus operaciones:
ParámetroComandoDescripción
client-id--client-id <string>El identificador único de cliente utilizado para autenticación.
client-secret--client-secret <string>La clave secreta utilizada para validar la identidad del cliente.
url-api-auth--url-api-auth <string>La URL del servicio de autenticación.
url-api-ledger--url-api-ledger <string>La URL del servicio responsable del ledger.