github.com/TrueBlocks/trueblocks-core/src/apps/chifra@v0.0.0-20241022031540-b362680128f7/internal/status/README.md (about)

     1  ## chifra status
     2  
     3  The `chifra status` tool reports on the state (and size) of the various TrueBlocks local binary
     4  caches. TrueBlocks produces nine difference caches: `abis`, `blocks`, `monitors`, `names`, `objs`,
     5  `recons`, `slurps`, `traces`, `transactions`. In general practice, these caches may take up a
     6  few GB of hard drive space, however, for very popular smart contract the size of the caches may
     7  grow rather large. Keep an eye on it.
     8  
     9  The `chifra status` program allows you to manage the various TrueBlocks caches. You may list all of the
    10  caches, some of the cache, or even individual caches either in terse or full detail. The cache of
    11  interest is specified with the `modes` option.
    12  
    13  TrueBlocks maintains caches for the index of address appearances, named addresses, abi files, as
    14  well as other data including blockchain data, and address monitors.
    15  
    16  ```[plaintext]
    17  Purpose:
    18    Report on the state of the internal binary caches.
    19  
    20  Usage:
    21    chifra status <mode> [mode...] [flags]
    22  
    23  Arguments:
    24    modes - the (optional) name of the binary cache to report on, terse otherwise
    25      One or more of [ index | blooms | blocks | transactions | traces | logs | statements | results | state | tokens | monitors | names | abis | slurps | staging | unripe | maps | some | all ]
    26  
    27  Flags:
    28    -d, --diagnose            same as the default but with additional diagnostics
    29    -c, --first_record uint   the first record to process
    30    -e, --max_records uint    the maximum number of records to process (default 10000)
    31    -a, --chains              include a list of chain configurations in the output
    32    -k, --healthcheck         an alias for the diagnose endpoint
    33    -x, --fmt string          export format, one of [none|json*|txt|csv]
    34    -v, --verbose             enable verbose output
    35    -h, --help                display this help screen
    36  
    37  Notes:
    38    - The some mode includes index, monitors, names, slurps, and abis.
    39    - If no mode is supplied, a terse report is generated.
    40  ```
    41  
    42  Data models produced by this tool:
    43  
    44  - [cacheitem](/data-model/admin/#cacheitem)
    45  - [chain](/data-model/admin/#chain)
    46  - [status](/data-model/admin/#status)
    47  
    48  ### Other Options
    49  
    50  All tools accept the following additional flags, although in some cases, they have no meaning.
    51  
    52  ```[plaintext]
    53    -v, --version         display the current version of the tool
    54        --output string   write the results to file 'fn' and return the filename
    55        --append          for --output command only append to instead of replace contents of file
    56        --file string     specify multiple sets of command line options in a file
    57  ```
    58  
    59  **Note:** For the `--file string` option, you may place a series of valid command lines in a file using any
    60  valid flags. In some cases, this may significantly improve performance. A semi-colon at the start
    61  of any line makes it a comment.
    62  
    63  **Note:** If you use `--output --append` option and at the same time the `--file` option, you may not switch
    64  export formats in the command file. For example, a command file with two different commands, one with `--fmt csv`
    65  and the other with `--fmt json` will produce both invalid CSV and invalid JSON.
    66  
    67  *Copyright (c) 2024, TrueBlocks, LLC. All rights reserved. Generated with goMaker.*