Coder Social home page Coder Social logo

creeder's Introduction

๐Ÿ–จ๏ธ Creeder

README.md fully written by ChatGPT ๐Ÿค–

Creeder is a command-line interface written in Go that reads all files in a source code directory, prints the file tree of that directory, and prints the contents of each file.

Installation

To use the CLI tool, you must have Go installed on your computer. You can then install using the following command:

$ go get github.com/impzero/creeder

Usage

To use the CLI Tool, run the following command:

$ creeder <path> [-f <filter>] [-i <ignore>]

where:

  • <path> is the path to the source code directory
  • -f <filter> is an optional comma-separated list of file extensions to include (default is all files)
  • -i <ignore> is an optional comma-separated list of directories or files to ignore (default is none)

For example, to print the files tree and contents of all .go and .txt files in the /path/to/dir directory, ignoring the node_modules and vendor directories, run the following command:

$ creeder /path/to/dir -f go,txt -i node_modules,vendor

Purpose

Build this tool for a couple of reasons:

  • โ˜• Lazy and uneducated about any others tools that would do this job
  • โš’๏ธ Need the response produced by this tool in order to create embeddings for ChatGPT for another project
  • ๐Ÿ“š Learn more about Go and how to build CLI tools
  • ๐Ÿค– Experiment being a "professional" ChatGPT code prompter

Contributing

If you have any suggestions or find any issues, please feel free to open an issue or pull request on GitHub.

License

Creeder is licensed under the MIT license. See LICENSE for more information.

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.