Referencia del CLI

La CLI proporciona un conjunto de comandos para administrar registros en tu ledger. Puedes instalarla globalmente desde NPM para usar los comandos desde tu terminal.

# Usando npm
npm install -g @minka/cli

# Usando yarn
yarn global add @minka/cli

Sinopsis Principal

minka <concepto-clave> <comando> [parámetros] [opciones]

Si deseas leer más sobre nuestros conceptos clave, consulta esta página. Los conceptos principales incluyen: Anchor, Domain, Signer, Symbol, Wallet, Intent y Effect.

minka server

Los comandos minka server <comando> se utilizan para administrar la conexión al servidor que se usará desde tu CLI. La mayoría de los comandos que se mencionan a continuación requieren una conexión activa. Puedes considerar un servidor como el entorno al que te estás conectando.

Por ejemplo:

• Entorno de pruebas (staging): https://ldg-stg.one/api/v2

Comandos disponibles

minka server connect

Te solicita ingresar la URL de una API de Ledger para conectarte. Si la URL corresponde a una instancia válida del servidor, recibirás un mensaje indicando que la conexión fue exitosa.

minka server disconnect

Desconecta el servidor remoto luego de una confirmación.

minka server show

Muestra el servidor actual al que estás conectado (si hay alguno).

minka ledger

Los comandos minka ledger <comando> se utilizan para administrar las instancias de ledger en el servidor conectado. Esto depende del entorno:

• Entorno de pruebas: kamin-stg
• Entorno de producción: kamin

Comandos disponibles

minka ledger login

Te permite seleccionar un signer para iniciar sesión.
El encabezado Authorization de las solicitudes se configura con un JWT firmado por el signer autenticado.
Los signers remotos se mostrarán si estás conectado a una instancia de ledger; de lo contrario, solo verás los signers del dispositivo.

minka ledger show

Muestra los detalles del ledger activo.

minka signer

Los comandos minka signer <comando> se utilizan para administrar claves de firma locales y remotas.

Comandos disponibles

minka signer create [handle] [opciones]

Te solicita la información necesaria para ingresar un par de claves y almacenarlo en la base de datos del servidor o localmente.

• Parámetros

  [handle]
  Identificador del signer a crear. Si no se especifica, se solicitará por consola.

• Opciones

  --no-secret
  Omite la solicitud de clave secreta al ingresar un par de claves manualmente. Útil si solo quieres registrar la clave pública en el ledger.

  -i, --import
  Omite el selector del método de ingreso y usa directamente “Importar”.

minka signer import [filename]

Te solicita la información requerida para importar un archivo PEM a un signer.

• Parámetros

  [filename]
  Ruta del archivo a importar. Si no se especifica, se solicitará por consola.

minka signer show <handle> [opciones]

Muestra los detalles del signer cuyo identificador es <handle>.

• Parámetros

  <handle>
  Identificador del signer a consultar.

• Opciones

  -s, --secret
  Muestra la clave secreta del signer. Si está encriptada, se solicitará la contraseña.

  -r, --remote
  Consulta un signer remoto en lugar de uno local.

minka signer list [opciones]

Muestra una lista de signers.

• Opciones

  -p <índice>, --page <índice>
  Índice de la página a cargar (comienza desde 0). Por defecto: 0

  -l <límite>, --limit <límite>
  Número máximo de elementos por página. Por defecto: 10

  -r, --remote
  Consulta signers remotos en lugar de los locales.

  -i, --interactive
  Permite navegación interactiva si hay múltiples páginas.

minka anchor

Los comandos minka anchor <comando> se utilizan para administrar los anchors almacenados en la base de datos del servidor.

Comandos disponibles

minka anchor show <handle>

Muestra los detalles del anchor cuyo identificador es <handle>.

• Parámetros

  <handle>
  Identificador del anchor remoto a consultar.

minka anchor list [opciones]

Muestra una lista de anchors.

• Opciones

  -p <índice>, --page <índice>
  Índice de la página a cargar (comienza desde 0). Por defecto: 0

  -l <límite>, --limit <límite>
  Número máximo de elementos por página. Por defecto: 10

  -i, --interactive
  Permite navegación interactiva si hay múltiples páginas.

minka effect

Los comandos minka effect <comando> se utilizan para administrar los efectos en la base de datos del servidor.

Comandos disponibles

minka effect create

Te solicita la información requerida para crear un nuevo effect.

minka effect show <handle>

Muestra los detalles del effect cuyo identificador es <handle>.

• Parámetros

  <handle>
  Identificador del effect remoto a consultar.

minka effect update [opciones] <handle>

Te solicita la información necesaria para actualizar el effect cuyo identificador es <handle>.

• Parámetros

  <handle>
  Identificador del effect remoto a actualizar.

• Opciones

  -p <índice>, --page <índice>
  Índice de la página a cargar (comienza desde 0). Por defecto: 0

  -l <límite>, --limit <límite>
  Número máximo de elementos por página. Por defecto: 10

  -i, --interactive
  Permite navegación interactiva si hay múltiples páginas.

minka effect list [opciones]

Muestra una lista de effects.

• Opciones

  -p <índice>, --page <índice>
  Índice de la página a cargar (comienza desde 0). Por defecto: 0

  -l <límite>, --limit <límite>
  Número máximo de elementos por página. Por defecto: 10

  -i, --interactive
  Permite navegación interactiva si hay múltiples páginas.

minka intent

Los comandos minka intent <comando> se utilizan para administrar y consultar intents creados en la base de datos del servidor.

Comandos disponibles

minka intent create

Te solicita la información requerida para iniciar un nuevo intent.

minka intent show <handle>

Muestra los detalles del intent cuyo identificador es <handle>.

• Parámetros

  <handle>
  Identificador remoto del intent a consultar.

minka intent sign <handle>

Te solicita la información requerida para agregar firmas al intent cuyo identificador es <handle>.

• Parámetros

  <handle>
  Identificador remoto del intent a firmar.

minka intent list [opciones]

Muestra una lista de intents.

• Opciones

  -p <índice>, --page <índice>
  Índice de la página a cargar (comienza desde 0). Por defecto: 0

  -l <límite>, --limit <límite>
  Número máximo de elementos por página. Por defecto: 10

  -i, --interactive
  Permite navegación interactiva si hay múltiples páginas.

minka wallet

Los comandos minka wallet <comando> se utilizan para administrar y consultar billeteras y sus saldos en la base de datos del servidor.

Comandos disponibles

minka wallet show <handle>

Muestra los detalles de la billetera cuyo identificador es <handle>.

minka wallet balances <handle>

Muestra los símbolos y saldos que posee la billetera cuyo identificador es <handle>.