Skip to main content

Description

When CardAK is used on the command line, it receives a command and optionally flags and parameters. The usage of the tool is this:

cardak [flags] [command] [parameters]

We can see the list of available commands usingh the HELP command:

$ cardak help
usage: cardak [<flags>] <command> [<args> ...]

A command-line tool for analyzing files.

Flags:
      --help     Show context-sensitive help (also try --help-long and --help-man).
  -v, --verbose  Add more information displayed on some commands.
      --mono     Supress color on output.
      --ignore   Try to ignore some errors and continue processing the file
  -W, --width    Ignore small terminal width check and force execution
  -z, --silent   Suppress all output (banner, headers, summary) except the results. Specially useful for DESCRIBE command piped to a search utility like fzf

Commands:
  help [<command>...]
  version
  chop [<flags>] <file>
  convert [<flags>] <format> <files>...
  create [<flags>] <file>
  delete [<flags>] <file>
  describe [<flags>] <field name> [<search pattern>]
  distribute [<flags>] <files>...
  duplicates [<flags>] <files>...
  export [<flags>] <files>...
  filter
    list [<flags>] [<file>]
    delete [<flags>] <file>
    rename [<flags>] <old> <new>
    copy [<flags>] <source> <destination>
    add [<flags>] <file> <fields>
    remove [<flags>] <file> <fields>
  fix [<flags>] <files>...
  grep [<flags>] <criteria> <files>...
  identify* [<flags>] <files>...
  import <file> <source>...
  join [<flags>] <files>...
  obfuscate [<flags>] <files>...
  open [<file>]
  print [<flags>] <files>...
  replace --search=SEARCH --replace=REPLACE [<flags>] <files>...
  split <files>...
  validate [<flags>] <files>...
tip

We always need to indicate the command to use, except for the IDENTIFY command which is assumed if no command is present.

List of available commands​

  • HELP: Displays this quick list or specific help for a given command
  • VERSION: Displays the tool version
  • CHOP: Extracts a record range from a file
  • CONVERT: Converts the file to a different format
  • CREATE: Creates an empty IPM file
  • DELETE: Deletes records or fields from an IPM file
  • DESCRIBE: Displays information about fields or other common values
  • DISTRIBUTE: Create different files with records based on a given criteria
  • DUPLICATES: Detects, reports and optionally deletes duplicate records in a file
  • EXPORT: Exports records from a file
  • FILTER: Filters records and allows to perform operations on them
  • FIX: Tries to automatically fix error in files
  • GREP: Search for data inside files using advanced criteria
  • IDENTIFY: Identifies the given files
  • IMPORT: Imports previously exported records to a file
  • JOIN: Combines different files into a single one
  • OBFUSCATE: Automatically changes sensible data in files
  • OPEN: Opens the file in TUI mode (interactive visual mode)
  • PRINT: Prints contents of the file in a user friendly way
  • REPLACE: Replaces values in records and files
  • SPLIT: Divides a file into smaller ones
  • VALIDATE: Validates the structure and integrity of an IPM file