FileGPT

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 26, 2023 License: MIT Imports: 15 Imported by: 0

README

FileGPT

FileGPT is a Golang application that can take multiple text files as input and generate text files as output. This program is designed to store conversations in an easy-to-use format using text files, which can even be structured like JSON, XML, and more.

Getting Started

To get started, you can install the CLI application by running go install github.com/bachittle/FileGPT@latest. Please ensure that you have set up your environment variable to have OPENAI_API_KEY set to your secret key (something like sk-xxx). You can set this variable in powershell for Windows using $env, in Linux using bash variables and/or export, or through a .env file.

Examples

There are several examples to try out in the examples/ folder:

  • readme_init.txt: natural language instructions for generating this README.
  • readme_edit.txt: natural language instructions for editing the existing README.
  • single_file_parsed.md : a single file chat, parsed to simulate API conversation flow (system => user => assistant => ...)
  • single_file.txt: a single unstructured text file. Only sends as one user message, gets one response by assistant. No system messages (yet).
  • folder/: a folder conversation containing multiple files with filenames formatted as 000_ROLE.md.

Usage

FileGPT can be used as a high-level wrapper for GPT and can potentially automate GPT instructions. The CLI specifies the inputs that will be provided, and GPT will return the corresponding output to a specified location in the command line. For example, you can provide code or data as input, along with a prompt instructing the bot on what to do with the input. The output can be in various formats such as markdown, Python code with commands explaining things, CSV/Excel/Word, and more.

Contributions

If you want to contribute to the development of FileGPT, please feel free to submit a pull request or create an issue on the repository. We welcome all contributions, and we thank you in advance for your support!

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL