Skip to main content

A CLI tool that analyzes a directory and displays a colourful chart of file type distribution.

Project description

StarType23

StarType23 screenshot

A CLI tool that walks a directory, counts files by extension, and renders a colourful file-type distribution chart in the terminal.

Features

  • Scans recursively and groups files by extension (count and disk size).
  • Renders a stacked proportion bar + a table with coloured mini bars.
  • Two modes: by count (startype23) or by size (startype23 --size).
  • Built-in lookup table of ~500 extensions with file-type category and one-line description (--explain .py).
  • Column visibility toggles: --filetype, --count, --percentage, --distribution.
  • Skips .git, .venv, node_modules, __pycache__, and similar by default.
  • Flat-design pastel colour palette (no neon).
  • Custom colour palette support via --colors (inline hex codes or file).

Installation

uv tool install startype23
# or via pip:
pip install startype23

After installation, both startype23 and st23 are available globally.

Usage

startype23 (or st23)                    scan current directory
startype23 --size                       scan by disk size
startype23 --path /some/dir             scan a specific directory
startype23 --include-hidden             include dotfiles
startype23 --explain .py                look up an extension
startype23 --explain py                 leading dot is optional
startype23 --exclude build              skip extra directories
startype23 --count --percentage         show only selected columns
startype23 --colors FF0000 --colors 00FF00   custom colours
startype23 --colors "#FF0000,#00FF00"       comma-separated in one string
startype23 --colors /path/to/colors.txt     load from file
Flag Description
--path Directory to scan (default: .)
--exclude / -x Extra directory names to skip (repeatable)
--include-hidden Include dotfiles in the scan
--no-include-hidden Exclude dotfiles (default)
--explain / -e Look up an extension and show its description
--size / -s Size distribution instead of count
--filetype / -ft Show the File Type column
--count / -c Show the Count column
--percentage / -p Show the Percentage column
--distribution / -d Show the Distribution bar column
--colors Hex colour codes, one per flag, comma/space/semicolon/colon separated, or path to a colour file

When no column flags are given, all columns show. When one or more are given, only those (plus Extension) are shown.

Custom colours can be provided inline or via a text file. The # prefix is optional. If fewer colours are given than file types found, the tool falls back to the built-in palette and prints a warning. A default colour file at $HOME/.config/startype23/colors.txt is loaded automatically if no --colors flag is given.

Tools used to build this project

  • Python 3.10+ -- language runtime.
  • uv -- package and project manager (install, build, publish).
  • click -- CLI framework (arguments, options, help).
  • rich -- terminal styling (tables, colours, text formatting).
  • hatchling -- build backend (PEP 517).
  • Wikipedia's List of filename extensions -- source for the ~500-entry extension lookup table.

Project details


Download files

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

Source Distribution

startype23-1.7.0.tar.gz (102.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

startype23-1.7.0-py3-none-any.whl (29.6 kB view details)

Uploaded Python 3

File details

Details for the file startype23-1.7.0.tar.gz.

File metadata

  • Download URL: startype23-1.7.0.tar.gz
  • Upload date:
  • Size: 102.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for startype23-1.7.0.tar.gz
Algorithm Hash digest
SHA256 810ad6f2a8f89b6467fada9e0f4a7f723168bd45bd08263a09c0d7ae201fe245
MD5 493fc0f15a4926eb91743337ae83dafa
BLAKE2b-256 4fe43e2089aff7757e810eb8eca8914e2ccfe6cd0752a197c23820a3fbc92f98

See more details on using hashes here.

File details

Details for the file startype23-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: startype23-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 29.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for startype23-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4723597423d03c970c90a1f886351e78c3f854c347d19bdd6f48482406cd9eed
MD5 1748a3a2fb59413d27fa278f3c52c9bc
BLAKE2b-256 28e5a5ae29d1c2ea987a590caa59758374e32ef75c66d7892fb5c5d069975e49

See more details on using hashes here.

Supported by

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