Centjes Cryptocurrencies

Documentation for downloading cryptocurrency exchange rates

Reference

Options

  --config-file Path to the configuration file
  -l|--ledger ledger file default: "ledger.cent"
  download-rates Download cryptocurrency exchange rates
      --symbols         Comma-separated cryptocurrency symbols to download (default: all currencies from ledger)                                                     
      --target|--target Target currency symbol                                                                   default: CurrencySymbol {currencySymbolText = "USD"}
      --begin           The begin date (inclusive), default: Start of the year                                                                                       
      --end             The final date (inclusive), default: Yesterday                                                                                               
      -o|--output       Output file path (default: stdout)                                                                                                           

Environment variables

  CENTJES_CRYPTOCURRENCIES_CONFIG_FILE FILE_PATH   Path to the configuration file                                                                               
  CENTJES_CRYPTOCURRENCIES_LEDGER FILE_PATH        ledger file                                              default: "ledger.cent"                              
  CENTJES_CRYPTOCURRENCIES_TARGET CURRENCY         Target currency symbol                                   default: CurrencySymbol {currencySymbolText = "USD"}
  CENTJES_CRYPTOCURRENCIES_BEGIN YYYY-MM-DD        The begin date (inclusive), default: Start of the year                                                       
  CENTJES_CRYPTOCURRENCIES_END YYYY-MM-DD          The final date (inclusive), default: Yesterday                                                               
  CENTJES_CRYPTOCURRENCIES_OUTPUT FILE_PATH        Output file path (default: stdout)                                                                           

Configuration values

  ledger file
  default: "ledger.cent"
  ledger:
    # or null
    <string>
  Target currency symbol
  default: CurrencySymbol {currencySymbolText = "USD"}
  download-rates.target:
    # or null
    <string>
  The begin date (inclusive), default: Start of the year
  download-rates.begin:
    # or null
    # Day
    <string>
  The final date (inclusive), default: Yesterday
  download-rates.end:
    # or null
    # Day
    <string>
  Output file path (default: stdout)
  download-rates.output:
    # or null
    <string>

Combined settings

Usage: centjes-cryptocurrencies [--config-file FILE_PATH] [-l|--ledger FILE_PATH] COMMAND

All settings:
  Show this help text
  switch: -h|--help

  Output version information
  switch: --version

  Path to the configuration file
  option: --config-file FILE_PATH
  env: CENTJES_CRYPTOCURRENCIES_CONFIG_FILE FILE_PATH

  ledger file
  option: -l|--ledger FILE_PATH
  env: CENTJES_CRYPTOCURRENCIES_LEDGER FILE_PATH
  config:
    ledger: # or null
      <string>
  default: "ledger.cent"

All commands:
  Download cryptocurrency exchange rates
  command: download-rates
    Comma-separated cryptocurrency symbols to download (default: all currencies from ledger)
    option: --symbols SYMBOLS
    
    Target currency symbol
    option: --target|--target CURRENCY
    env: CENTJES_CRYPTOCURRENCIES_TARGET CURRENCY
    config:
      download-rates.target: # or null
        <string>
    default: CurrencySymbol {currencySymbolText = "USD"}
    
    The begin date (inclusive), default: Start of the year
    option: --begin YYYY-MM-DD
    env: CENTJES_CRYPTOCURRENCIES_BEGIN YYYY-MM-DD
    config:
      download-rates.begin: # or null
        # Day
        <string>
    
    The final date (inclusive), default: Yesterday
    option: --end YYYY-MM-DD
    env: CENTJES_CRYPTOCURRENCIES_END YYYY-MM-DD
    config:
      download-rates.end: # or null
        # Day
        <string>
    
    Output file path (default: stdout)
    option: -o|--output FILE_PATH
    env: CENTJES_CRYPTOCURRENCIES_OUTPUT FILE_PATH
    config:
      download-rates.output: # or null
        <string>
    
  

Options:
  -h|--help Show this help text
  --version Output version information
  --config-file Path to the configuration file
  -l|--ledger ledger file default: "ledger.cent"
  download-rates Download cryptocurrency exchange rates
      --symbols         Comma-separated cryptocurrency symbols to download (default: all currencies from ledger)                                                     
      --target|--target Target currency symbol                                                                   default: CurrencySymbol {currencySymbolText = "USD"}
      --begin           The begin date (inclusive), default: Start of the year                                                                                       
      --end             The final date (inclusive), default: Yesterday                                                                                               
      -o|--output       Output file path (default: stdout)                                                                                                           

Environment Variables:
  CENTJES_CRYPTOCURRENCIES_CONFIG_FILE FILE_PATH   Path to the configuration file                                                                               
  CENTJES_CRYPTOCURRENCIES_LEDGER FILE_PATH        ledger file                                              default: "ledger.cent"                              
  CENTJES_CRYPTOCURRENCIES_TARGET CURRENCY         Target currency symbol                                   default: CurrencySymbol {currencySymbolText = "USD"}
  CENTJES_CRYPTOCURRENCIES_BEGIN YYYY-MM-DD        The begin date (inclusive), default: Start of the year                                                       
  CENTJES_CRYPTOCURRENCIES_END YYYY-MM-DD          The final date (inclusive), default: Yesterday                                                               
  CENTJES_CRYPTOCURRENCIES_OUTPUT FILE_PATH        Output file path (default: stdout)                                                                           

Configuration Values:
  ledger file
  default: "ledger.cent"
  ledger:
    # or null
    <string>
  Target currency symbol
  default: CurrencySymbol {currencySymbolText = "USD"}
  download-rates.target:
    # or null
    <string>
  The begin date (inclusive), default: Start of the year
  download-rates.begin:
    # or null
    # Day
    <string>
  The final date (inclusive), default: Yesterday
  download-rates.end:
    # or null
    # Day
    <string>
  Output file path (default: stdout)
  download-rates.output:
    # or null
    <string>