felix

command module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 15, 2025 License: GPL-3.0 Imports: 7 Imported by: 0

README ΒΆ

Felix the Recursive Cat Banner

🐱 Felix β€” A Recursive Cat

Go Version Build

Felix is a small but powerful command-line tool written in Go 🧰
It recursively reads files that match wildcard patterns (like *.md, **/*.txt, etc.)
and prints their contents β€” just like the Unix cat, but recursive and smart 🐾

β€œFelix” comes from Latin, meaning happy or lucky.

It’s also a nod to our feline friends β€” perfect for a recursive cat. 🐾


✨ Features

  • πŸ“‚ Recursive glob pattern support (**/*.md)
  • 🧾 Multiple file patterns (*.md, *.txt, etc.)
  • βš™οΈ Output redirection (-o output.txt)
  • 🚫 Automatic binary file detection and skip
  • πŸ’™ Pure Go β€” no external dependencies besides doublestar

πŸš€ Installation

Prerequisites
Install directly from GitHub
go install github.com/AdaiasMagdiel/felix@latest

🧰 Usage

felix [options] <pattern1> [<pattern2> ...]
Examples:
felix **/*.md
felix *.txt *.log
felix -o combined.txt **/*.md
Output:
===== docs/readme.md =====
# Introduction
Welcome to Felix!

===== notes/todo.txt =====
- [x] Implement recursive globbing
- [x] Detect and skip binary files
- [x] Add output redirection

βš™οΈ Build from source

git clone https://github.com/AdaiasMagdiel/felix.git
cd felix
go build ./cmd/felix

🧱 Project structure

felix/
β”œβ”€β”€ assets/
β”‚   └── banner.jpg
β”œβ”€β”€ main.go
β”œβ”€β”€ go.mod
β”œβ”€β”€ go.sum
β”œβ”€β”€ COPYRIGHT
β”œβ”€β”€ LICENSE
└── README.md

πŸ“œ License

Licensed under the GNU General Public License v3.0 (GPLv3). See the LICENSE file for details.

Documentation ΒΆ

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL