Skip to main content

Simple OS Independent 'cat' Command-line Tool made in Python.

Project description

OS-Windows OS-Linux OS-MacOS


cat_win

Simple Command-line Tool made in Python
Explore the code »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Changelog
  5. License
  6. Contact

About The Project

Unittests Build-and-Check

This project copies the fundamental framework of the cat command-line tool from Linux and translates its features to an OS Independent program using Python.

Additionally it includes the feature to strip and reverse the content of any given file, make use of the standard-input, which enables cat piping into each other, generating the checksum of any file, converting decimal, hexadecimal and binary numbers within any text, and much more ...

Contrary to the name of the project it is of course possible to use cat_win on Linux or MacOS!

Made With

MadeWith-Python

(back to top)

Getting Started

Prerequisites

No Prerequisites are neccessary; The stand-alone executable catw.exe is sufficient.

⚠️ You should never trust any executable file!

Installation

Simply install the python package (PyPI-cat_win):

pip install cat-win

OR alternatively:

  1. Clone the repository and move into the root\bin directory with:
git clone git@github.com:SilenZcience/cat_win.git
cd cat_win\bin
  1. Add the directory to your system-environment PATH-variables.

(back to top)

Usage

catw [FILE]... [OPTION]...
catw --help

⚠️ from v1.0.33 to v1.1.0 the entrypoint changes from cat to catw. If you wish to keep the old command, you will have to define an alias yourself.

Argument / Option Description
-h, --help show help message and exit
-v, --version output version information
-d, --debug show debug information
-n, --number number all output lines
-l, --linelength display the length of each line
-e, --ends display $ at the end of each line
-t, --tabs display TAB characters as ^I
--eof, --eof display EOF characters as ^EOF
-u, --unique suppress repeated output lines
-b, --blank hide empty lines
-r, --reverse reverse output
-s, --sum show sum of lines
-f, --files list applied files
-F, --FILES ONLY list applied files
-k, --keyword only show lines containing queried keywords
-i, --interactive use stdin
-o, --oneline take only the first stdin-line
-p, --peek only print the first and last lines
-c, --clip copy output to clipboard
-m, --checksum show the checksums of all files
-a, --attributes show meta-information about the files
--dec, --DEC convert decimal numbers to hexadecimal and binary
--hex, --HEX convert hexadecimal numbers to decimal and binary
--bin, --BIN convert binary numbers to decimal and hexadecimal
--b64e, --b64e encode the input to base64
--b64d, --b64d decode the input from base64
--nc, --nocolor disable colored output
--nb, --nobreak do not interrupt the output on queried keywords
--config, --config change color configuration
enc=X set file enconding to X (default is utf-8)
find=X find/query a substring X in the given files
match=X find/query a pattern X in the given files
trunc=X:Y truncate file to lines X and Y (python-like)
[a,b] replace a with b in every line
[a:​b:c] python-like string indexing syntax (line by line)

Examples

Images

Example1

Example2

Example3

Example4

Example5

$ echo "Hello World :)" | catw -i [6:] | catw -i [::-1] -ln
> 1) [8] ): dlroW

(back to top)

Changelog

Take a look at the Changelog file.

License

This project is licensed under the MIT License - see the LICENSE file for details

Contact

SilenZcience
GitHub-SilenZcience

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

cat_win-1.1.2-py3-none-any.whl (25.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page