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

     1  ## chifra names
     2  
     3  `chifra names` is a surprisingly useful tool. It allows one to associate textual names with Ethereum
     4  addresses. One may ask why this is necessary given that ENS exists. The answer is a single
     5  word: "privacy". ENS names are public. In many cases, users desire to keep personal addresses
     6  private. Try to do this on a website.
     7  
     8  Like `chifra abis`, this tool is useful from the command line but is primarily used in support of
     9  other tools, especially `chifra export` where naming addresses becomes the single best way to
    10  turn unintelligible blockchain data into understandable information.
    11  
    12  The various options allow you to search and filter the results. The `tags` option is used primarily
    13  by the TrueBlocks explorer.
    14  
    15  You may use the TrueBlocks explorer to manage (add, edit, delete) address-name associations.
    16  
    17  ```[plaintext]
    18  Purpose:
    19    Query addresses or names of well-known accounts.
    20  
    21  Usage:
    22    chifra names [flags] <term> [term...]
    23  
    24  Arguments:
    25    terms - a space separated list of one or more search terms (required)
    26  
    27  Flags:
    28    -e, --expand            expand search to include all fields (search name, address, and symbol otherwise)
    29    -m, --match_case        do case-sensitive search
    30    -a, --all               include all (including custom) names in the search
    31    -c, --custom            include only custom named accounts in the search
    32    -p, --prefund           include prefund accounts in the search
    33    -s, --addr              display only addresses in the results (useful for scripting, assumes --no_header)
    34    -g, --tags              export the list of tags and subtags only
    35    -C, --clean             clean the data (addrs to lower case, sort by addr)
    36    -r, --regular           only available with --clean, cleans regular names database
    37    -d, --dry_run           only available with --clean or --autoname, outputs changes to stdout instead of updating databases
    38    -A, --autoname string   an address assumed to be a token, added automatically to names database if true
    39    -x, --fmt string        export format, one of [none|json*|txt|csv]
    40    -v, --verbose           enable verbose output
    41    -h, --help              display this help screen
    42  
    43  Notes:
    44    - The tool will accept up to three terms, each of which must match against any field in the database.
    45    - The --match_case option enables case sensitive matching.
    46  ```
    47  
    48  Data models produced by this tool:
    49  
    50  - [message](/data-model/other/#message)
    51  - [name](/data-model/accounts/#name)
    52  
    53  ### Other Options
    54  
    55  All tools accept the following additional flags, although in some cases, they have no meaning.
    56  
    57  ```[plaintext]
    58    -v, --version         display the current version of the tool
    59        --output string   write the results to file 'fn' and return the filename
    60        --append          for --output command only append to instead of replace contents of file
    61        --file string     specify multiple sets of command line options in a file
    62  ```
    63  
    64  **Note:** For the `--file string` option, you may place a series of valid command lines in a file using any
    65  valid flags. In some cases, this may significantly improve performance. A semi-colon at the start
    66  of any line makes it a comment.
    67  
    68  **Note:** If you use `--output --append` option and at the same time the `--file` option, you may not switch
    69  export formats in the command file. For example, a command file with two different commands, one with `--fmt csv`
    70  and the other with `--fmt json` will produce both invalid CSV and invalid JSON.
    71  
    72  *Copyright (c) 2024, TrueBlocks, LLC. All rights reserved. Generated with goMaker.*