Code Monkey home page Code Monkey logo

repo-cat's Introduction

repo-cat

Description

repo-cat recursively traverses the current working directory and copies the contents of all files (except for specified exclusions) into a single output file. It supports ignoring files, folders, and file extensions based on command-line options and the project's .gitignore file. Additionally, it provides metadata for image and SVG files, including dimensions and file size.

Installation

  1. Clone the repository
  2. Navigate to the project directory
  3. Install the package globally
npm install -g .

Usage

repo-cat [options]

Options

  • --ignore-files <files...>: Space-separated list of files to ignore.
  • --ignore-folders <folders...>: Space-separated list of folders to ignore.
  • --ignore-exts <extensions...>: Space-separated list of file extensions to ignore (without the dot).
  • -o, --output <file>: Output file name (default: repo-contents.txt).

Example

To create a file named project-snapshot.txt containing the contents of the current repository, excluding the node_modules folder, .env files, and .png and .jpg image files, run:

repo-cat --ignore-folders node_modules --ignore-files .env --ignore-exts .png .jpg -o project-snapshot.txt

Default Ignored Patterns

By default, repo-cat ignores the following patterns:

  • .git/** (Git repository files)
  • **/.* (Hidden files)
  • **/*.mp4, **/*.mkv, **/*.avi, **/*.mov, **/*.wmv (Video files)
  • **/*.zip, **/*.rar, **/*.tgz (Compressed files)

repo-cat's People

Contributors

viscousguy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.