Skip to main content

Cross-platform CLI tool to analyze and summarize project structures with SOLID design patterns

Project description

fscribe

fscribe is a command-line tool that summarizes file structures into formatted text, JSON, and Markdown for easier parsing and integration with LLMs.

Features

  • Generates a structured summary of directories and files
  • Supports output in text (.txt), JSON (.json), and Markdown (.md)
  • Uses asynchronous processing for efficient file reading
  • Provides file statistics, including total files, total size, and detected programming languages
  • Includes a progress bar for large projects
  • Uses colorized terminal output for enhanced readability

Installation

Using pip

pip install fscribe

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

fscribe-1.0.0.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

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

fscribe-1.0.0-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

Details for the file fscribe-1.0.0.tar.gz.

File metadata

  • Download URL: fscribe-1.0.0.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for fscribe-1.0.0.tar.gz
Algorithm Hash digest
SHA256 71873afa0dd828f981044211c04298a6bacc11c44449267ea8e15731393acda7
MD5 1ac03aad9d6f7310f6882b59e33652f0
BLAKE2b-256 8bc5b68ae7426c33b1d643565e9c9f4ec7da8c53e8a34b34c225211663c26379

See more details on using hashes here.

File details

Details for the file fscribe-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: fscribe-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 15.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for fscribe-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7ca053c37532842df0b673fbf147278914a8bde03478b52ca99310b9c69bbe87
MD5 79b0658ed2b70653b8b6b14041bcf13e
BLAKE2b-256 95eee26ab8be0e481a9ec0838ec24ccefcc703b9ca93e0eeb6d402e6de7e91a1

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