Skip to main content

A utilty to flatten your source code directory into a single file for LLM usage

Project description

flort

flort is a command-line tool for generating a single file with the contents of your code directories.. for use in LLMs.

Installation

You can install flort via pip:

pip install flort

Usage

flort provides various options for listing and cleaning up files in a directory.

flort --dir <directory_path> [--compress] [--output <output_file>] [--php] [--js] [--py] [--c] [--cpp] [--tree]

Options

  • --dir: Specify the directory to list files from (required).
  • --compress: Clean up files by removing unnecessary whitespace (optional).
  • --output: Specify the output file path (default: stdout).
  • --php, --js, --py, --c, --cpp: Include specific file types in the listing (optional).
  • --tree: Print the directory tree at the beginning of the output (optional).

Examples

List files in a directory and include PHP files:

flort --dir /path/to/directory --php

Clean up files in a directory and save the output to a file:

flort --dir /path/to/directory --compress --output output.txt

List files in a directory, include JavaScript and Python files, and print the directory tree:

flort --dir /path/to/directory --js --py --tree

License

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.

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

flort-0.1.1.tar.gz (3.2 kB view details)

Uploaded Source

File details

Details for the file flort-0.1.1.tar.gz.

File metadata

  • Download URL: flort-0.1.1.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.6

File hashes

Hashes for flort-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ff157e5e863abe95c25d2e65f4b6dbffebcedb4aa48e6d1b78bc38550b09ec0a
MD5 0f5c91cf699f1b82bc42e6eca1a3aa10
BLAKE2b-256 c3bfc3b09a151f17cf453200c13eb35a341835794ed3238b80cd27307704fbf8

See more details on using hashes here.

Supported by

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