flocc(1)

📦 version 0.1, in opensuse-leap 16.0

💅 flocc(1) — the Development Tools girlies know

okay so bestie, buckle up, because this is flocc(1), the manual page for flocc — The Fast Lines Of Code Counter, and honestly? it ate. it's giving "I just want to know how many lines of code I actually wrote" main character energy 🎀

✨ NAME ✨

flocc — The Fast Lines Of Code Counter ⚡ (yes that capitalisation is canon, respect it)

🌸 SYNOPSIS 🌸

flocc [OPTIONS] [DIRECTORY]

🦋 DESCRIPTION 🦋

The Fast Lines of Code Counter (that's flocc to its friends 💖) scans a directory tree full of source files and counts the lines of code, the comments, and the blank lines. three separate counts, no cap.

After it's done scanning, it prints a summary of those counts, split up by programming or markup language if it found any 🗂️ Flocc figures out what type each source file is by looking at the file extension — that's the whole vibe check, iykyk.

and the iconic part: the directory tree it walks can live on a file-system, or it can be a git tree-object 👑 two completely different worlds, one tool.

🔥 OPTIONS 🔥

  • -h, --help — lists all the available options with a short description next to each one, then dips out (exits). we love a self-aware queen 🫶
  • --version — prints the version and copyright info and exits. periodt.
  • -g, --git — switches on git mode and traverses the directory tree starting from a git object. when you use --git, the [DIRECTORY] you pass has to point to a git revision. and the best part? the revision does not need to be checked out in the working tree. ngl that's kind of iconic 💅
  • -r <repo>, --repo <repo> — points <repo> at the file-system path where the git repository lives. this one's only useful alongside --git, so don't come for it when it's alone 🙈
  • --json <file> — stores the detailed numbers in JSON format into <file>. it saves the detailed numbers and the detected language type for every single scanned file as JSON data. data girlies rise 🌈
  • --dump-unknown — prints info about any unknown file extensions it ran into. mostly useful for development and testing of flocc itself, so like... dev-only tea ☕

👑 AUTHOR 👑

Written by Joerg Roedel ✨

💀 REPORTING BUGS 💀

Please report bugs directly to jroedel@suse.de — send them straight to the source, no middleman, fr fr 📩

Copyright 2021 SUSE

License: GPL-2.0+

https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
⭐ lowkey important one: flocc version 0.1, dated 2024-03-13. that's the whole footer era, mwah 💜
📦 where this page comes from