Primeros pasos
Instalación
CardAK se distribuye como un ejecutable portable. No requiere instalación adicional.
Basta con copiar el archivo ejecutable en una carpeta que esté incluida en el PATH de la cuenta de usuario.
Uso Básico
cardak [COMANDO] [OPCIONES] [ARCHIVOS]
El comando recibe (opcionalmente) el nombre de un comando, flags (con y sin parámetros) y uno o más nombres de archivo. Dependiendo del comando, puede ser obligatorio proporcionar al menos un nombre de archivos.
Los flags son modificadores sobre el comando, existiendo flags genéricos a la aplicación, y otros que son específicos de cada comando.
El orden de estos componentes no suele ser fijo (salvo algunas excepciones), y los comandos pueden ser escritos tanto en mayúsculas como en minúsculas, y también pueden abreviarse utilizando las primeras letras del comando (siempre que esas letras identifiquen al comando en forma inambigua, por ejemplo VERSION es lo mismo que VER o VERS)
Lo primero que podemos hacer es utilizar un comando para verificar la versión que estamos utilizando. Para ellos usaremos el comando VERSION
Lo siguiente es ver los comandos disponibles y una breve descripción de su propósito y algunos flags globales. Para ellos podemos usar tanto el comando HELP como el flag --help. La ventaja de utilizar el flag es que funciona con cualquier comando, por lo que si tenemos alguna duda de los flags a utilizar con un comando cualquiera, basta con agregar este flag al final y repetir el último comando para obtener ayuda.
Veamos la lista de comandos disponibles utilizando el comando HELP
Para obtener ayuda sobre un comando específico:
cardak [COMANDO] --help
o bien
cardak HELP [COMANDO]
Modos de uso
Existen tres formas de utilizar esta herramienta. En modo CLI (Command Line Interface), en modo TUI (Text User Interface), o en modo BATCH.
La herramienta intenta detectar automáticamente el modo utilizado y ajusta determinados valores en función del modo, los que veremos detalladamente en otra sección
Modo CLI (Linea de comandos)
Esta es la modalidad preferida para acciones rapidas o que involucran archivos muy grandes, o cuando tenemos que procesar varios archivos.
Esta modalidad está pensada para ser utilizada por personas y la salida tiende a tener un formato amigable y en lo posible se hace el uso de colores para mejorar la visibilidad de los datos
Modo Interactivo (TUI)
CardAK incluye una interfaz de usuario de texto interactiva que permite explorar archivos de intercambio de manera visual. A este modo accedemos usando el comando OPEN e indicando un nombre de archivos. Es importante notar que este es un comando que debe recibir un nombre de archivo (y solo uno).
Ejemplo:
cardak OPEN [ARCHIVO]
Modo BATCH
Este modo es similar al de línea de comandos, pero está pensado para usarse en procesos de automatización y scripts, donde la salida no está pensada para ser visualmente atractiva sino funcional.
La salida de los comandos suenen ser solo los datos requeridos, sin adornos adicionales (sin el banner ni pie al final de la ejecución), se omite el control del tamaño de la terminal y se suprimen los colores, ya que si queremos redirigir la salida del comando a un archivo, y los códigos de formato como los colores están presentes, suelen dificultar la visualización del contenido de esas redirecciones.
También el código de retorno del programa se indica con un valor de cero en caso de resultar exitoso, y un valor diferente de cero en caso de encontrar errores. Ejemplos y anotaciones sobre esos valores serán detallados en cada uno de los comandos si aplica.