Another implementation of wc (word count).
wildcat counts the lines, words, characters, and bytes of the given files and the files in the given directories. Also, it respects the ignore files, such as .gitignore. The excellent points than wc are as follows.
- handles the files in the directories,
- respects the
.gitignorefile, - reads files in the archive file such as jar, tar.gz, and etc.,
- supports the several output formats,
- accepts file list from file and stdin, and
- includes REST API server.
Note that this product is an example project for implementing Open Source Software.
wildcat version 1.2.0 wildcat [CLI_MODE_OPTIONS|SERVER_MODE_OPTIONS] [FILEs...|DIRs...|URLs...] CLI_MODE_OPTIONS -b, --byte Prints the number of bytes in each input file. -c, --character Prints the number of characters in each input file. If the given arguments do not contain multibyte characters, this option is equal to -b (--byte) option. -l, --line Prints the number of lines in each input file. -w, --word Prints the number of words in each input file. -a, --all Reads the hidden files. -f, --format <FORMAT> Prints results in a specified format. Available formats are: csv, json, xml, and default. Default is default. -H, --humanize Prints sizes in humanization. -n, --no-ignore Does not respect ignore files (.gitignore). If this option was specified, wildcat read .gitignore. -N, --no-extract-archive Does not extract archive files. If this option was specified, wildcat treats archive files as the single binary file. -P, --progress Shows progress bar for counting. -o, --output <DEST> Specifies the destination of the result. Default is standard output. -S, --store-content Sets to store the content of url targets. -t, --with-threads <NUM> Specifies the max thread number for counting. (Default is 10). The given value is less equals than 0, sets no max. -@, --filelist Treats the contents of arguments as file list. -h, --help Prints this message. -v, --version Prints the version of wildcat. SERVER_MODE_OPTIONS -p, --port <PORT> Specifies the port number of server. Default is 8080. If '--server' option did not specified, wildcat ignores this option. -s, --server Launches wildcat in the server mode. With this option, wildcat ignores CLI_MODE_OPTIONS and arguments. ARGUMENTS FILEs... Specifies counting targets. wildcat accepts zip/tar/tar.gz/tar.bz2/jar/war files. DIRs... Files in the given directory are as the input files. URLs... Specifies the urls for counting files (accept archive files). If no arguments are specified, the standard input is used. Moreover, -@ option is specified, the content of given files are the target files.To run wildcat with --server option, the wildcat start REST API server on port 8080 (default). Then, wildcat readies for the following endpoints.
gives the files in the request body, then returns the results in the JSON format. The example of results is shown in Json. Available query parameters are as follows.
file-name=<FILENAME>- this query param gives filename of the content in the request body.
readAs=no-extract- By specifying this query parameter, if client gives archive files,
wildcatserver does not extract archive files, and reads them as binary files.
- By specifying this query parameter, if client gives archive files,
readAs=file-list- By specifying this query parameter, client gives url list as input for
wildcatserver.
- By specifying this query parameter, client gives url list as input for
readAs=no-extract,file-listorreadAs=no-extract&readAs=file-list- This query parameter means the client requests the above both parameters. That is, the request body is url list, and archive files in the url list are treats as binary files. Note that, the order of
no-extractandfile-listdoes not care.
- This query parameter means the client requests the above both parameters. That is, the request body is url list, and archive files in the url list are treats as binary files. Note that, the order of
The available result formats are default, csv, json and xml. The examples of results are as follows by executing wildcat testdata/wc --format <FORMAT>.
Default format is almost same as the result of wc.
lines words characters bytes 4 26 142 142 testdata/wc/humpty_dumpty.txt 15 26 118 298 testdata/wc/ja/sakura_sakura.txt 59 260 1,341 1,341 testdata/wc/london_bridge_is_broken_down.txt 78 312 1,601 1,781 total (3 entries)file name,lines,words,characters,bytes testdata/wc/humpty_dumpty.txt,"4","26","142","142" testdata/wc/ja/sakura_sakura.txt,"15","26","118","298" testdata/wc/london_bridge_is_broken_down.txt,"59","260","1,341","1,341" total,"78","312","1,601","1,781"The following json is formatted by jq ..
{ "timestamp": "2021-02-16T14:59:40+09:00", "results": [ { "filename": "testdata/wc/humpty_dumpty.txt", "lines": "4", "words": "26", "characters": "142", "bytes": "142" }, { "filename": "testdata/wc/ja/sakura_sakura.txt", "lines": "15", "words": "26", "characters": "118", "bytes": "298" }, { "filename": "testdata/wc/london_bridge_is_broken_down.txt", "lines": "59", "words": "260", "characters": "1,341", "bytes": "1,341" }, { "filename": "total", "lines": "78", "words": "312", "characters": "1,601", "bytes": "1,781" } ] }The following xml is formatted by xmllint --format -
<?xml version="1.0"?> <wildcat> <timestamp>2021-02-16T14:58:06+09:00</timestamp> <results> <result> <file-name>testdata/wc/humpty_dumpty.txt</file-name> <lines>4</lines> <words>26</words> <characters>142</characters> <bytes>142</bytes> </result> <result> <file-name>testdata/wc/ja/sakura_sakura.txt</file-name> <lines>15</lines> <words>26</words> <characters>118</characters> <bytes>298</bytes> </result> <result> <file-name>testdata/wc/london_bridge_is_broken_down.txt</file-name> <lines>59</lines> <words>260</words> <characters>1,341</characters> <bytes>1,341</bytes> </result> <result> <file-name>total</file-name> <lines>78</lines> <words>312</words> <characters>1,601</characters> <bytes>1,781</bytes> </result> </results> </wildcat>$ docker run -v $PWD:/home/wildcat ghcr.io/tamada/wildcat:1.2.0 testdata/wcIf you run wildcat on server mode, run the following command.
$ docker run -p 8080:8080 -v $PWD:/home/wildcat ghcr.io/tamada/wildcat:1.2.0 --server1.2.0,latest1.1.11.1.01.0.31.0.21.0.11.0.0
Post the files to https://secret-coast-70208.herokuapp.com/wildcat/api/counts, like below.
$ curl -X POST --data-binary @testdata/archives/wc.jar https://secret-coast-70208.herokuapp.com/wildcat/api/counts {"timestamp":"2021-02-22T02:40:35+09:00","results":[{"filename":"<request>!humpty_dumpty.txt","lines":4,"words":26,"characters":142,"bytes":"142"},{"filename":"<request>!ja/","lines":"0","words":"0","characters":"0","bytes":"0"},{"filename":"<request>!ja/sakura_sakura.txt","lines":"15","words":"26","characters":"118","bytes":"298"},{"filename":"<request>!london_bridge_is_broken_down.txt","lines":"59","words":"260","characters":"1,341","bytes":"1,341"},{"filename":"total","lines":78,"words":"312","characters":"1,601","bytes":"1,781"}]} $ brew tap tamada/brew $ brew install wildcat$ git clone https://github.com/tamada/wildcat.git $ cd wildcat $ make
To cite this product, use the following BibTeX entry.
@misc{ tamada_wildcat, author = {Haruaki Tamada}, title = {Wildcat: another implementation of wc (word count)}, publisher = {GitHub}, howpublished = {\url{https://github.com/tamada/wildcat}}, year = {2021}, }
This icon is obtained from freesvg.org.
This project origin is wc command, and wc is the abbrev of 'word count.'
Wildcat can abbreviate as wc, too.