Skip to content

๐Ÿ›  Interactive Configuration

Gittxt offers a built-in installer to guide you through setting up your configuration file. This creates a gittxt-config.json file and stores your preferences for future scans.


๐Ÿš€ Run the Installer

gittxt config install

Youโ€™ll be prompted to define: - ๐Ÿ“ Output directory - ๐Ÿ“„ Default output formats (e.g., txt, json, md) - ๐Ÿ”Š Logging level (DEBUG, INFO, WARNING, ERROR) - ๐Ÿ“ฆ Auto-ZIP (enable or disable ZIP bundling) - ๐Ÿงฉ File filters (textual/non-textual extensions) - โŒ Excluded directories


๐Ÿ“ฆ Where Config is Stored

After installation, your preferences are saved to:

src/gittxt/gittxt-config.json
You can edit this file manually or re-run the installer anytime.


โœ… Sample CLI Usage After Install

Once configured, you can run:

gittxt scan .
Without passing extra flags โ€” your defaults will be used automatically.


๐Ÿง  Why Use It?

  • Simplifies CLI usage
  • Creates a persistent setup across sessions
  • Ideal for batch jobs or frequent usage

Next: Filter Manager โžก