Metadata-Version: 2.4
Name: pathetic-cli
Version: 0.3.1
Summary: A colorful CLI that visualizes system, environment, and PATH info with Rich.
Project-URL: Homepage, https://github.com/lancereinsmith/pathetic
Project-URL: Repository, https://github.com/lancereinsmith/pathetic
Project-URL: Issues, https://github.com/lancereinsmith/pathetic/issues
Author-email: Lance Reinsmith <info@k2rad.com>
License: MIT License
        
        Copyright (c) 2025 Lance Reinsmith
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >=3.12
Requires-Dist: click>=8.3.1
Requires-Dist: rich>=14.3.1
Description-Content-Type: text/markdown

# pathetic

A colorful, fast CLI to inspect your current environment: locations, system info, PATH with source tracing, Python environment, grouped environment variables, filesystem usage, and Git status. Built with Rich for delightful output and Click for a clean command-line UX.

## Highlights

- Visual, readable output with sensible defaults
- Responsive columnar layout that adapts to terminal width
- PATH entries traced back to their source file (.zshrc, /etc/paths, etc.)
- Shows the user's active Python, not the tool's isolated environment
- All environment variables grouped by category (Shell, Python, Git, Cloud, etc.)

## Requirements

- Python >= 3.11

## Installation

Install locally (editable) while developing:

```bash
uv pip install -e .
```

Or install globally with `uv tool`:

```bash
uv tool install pathetic-cli
```

This exposes the `ptc` command.

## Quickstart

Run the default, concise snapshot:

```bash
ptc
```

Show everything:

```bash
ptc --all
```

Machine-readable output:

```bash
ptc --json --all > snapshot.json
```

Focused views:

```bash
ptc --env                              # All env vars, grouped by category
ptc --fs                               # File system stats
ptc --env-key HOME --env-key EDITOR    # Specific env vars only
ptc --all --limit 50                   # More PATH/sys.path rows
```

## CLI Options

```text
ptc [OPTIONS]

Options:
  -h, --help         Show this message and exit
  --version          Show version
  --all              Show all sections
  --env              Show environment variables (grouped)
  --fs               Show file system stats
  --limit INTEGER    Max rows for PATH and sys.path (default: 25)
  --json             Output as JSON (machine-readable)
  --env-key TEXT     Show specific env vars (repeatable)
```

## What the tool shows

- **Location**: Current working directory and home directory
- **System**: Platform, user's active Python version, architecture, executable
- **Environment detection**: Active virtualenv/conda/uv info shown prominently
- **PATH**: First N entries with source file origin and executable count (configurable with `--limit`)
- **Python Path**: First N entries of `sys.path` (shown with `--all`)
- **Environment**: All variables grouped by category (`--env` or `--all`)
- **File System**: Total, free, used, and usage percent (`--fs` or `--all`)
- **Git**: Branch, short commit, working state (auto-detected when in a repo)

## Design philosophy

- Defaults show the most useful, actionable info quickly
- Additional details are opt-in via flags
- Clean typography and responsive layout with Rich
- PATH source tracing helps debug environment issues

## Development

Install dev dependencies and run locally:

```bash
uv pip install -e .
ptc --all
```

Project entry point is defined in `pyproject.toml`:

```toml
[project.scripts]
ptc = "pathetic:main"
```

## Troubleshooting

- Command not found after install: ensure your Python user base or pipx bin directory is on PATH.
- Missing colors or odd glyphs: use a modern terminal with UTF-8 and TrueColor support.

## License

MIT. See `LICENSE`.
