Git Product home page Git Product logo

siegfried-ai's Introduction

SiegfriedAI - Your Own ChatGPT Agents

Create and manage task specific GPT AI agents through text-based prompt templates.

Interact with OpenAI's GPT models from your CLI using prompt-based agents. Simply drop your text files with GPT prompts into the templates folder to create your customized chat agents. Use langchain to enhance it further.

SiegfriedAI example

โšก Installation

Clone the repository:

git clone https://github.com/steffenbew/siegfried-ai.git

Navigate to the project directory and install dependencies:

cd siegfried-ai
npm install

Set your OpenAI API key as an environment variable:

export OPENAI_API_KEY=your_openai_api_key_here

Your API key can be found here.

๐Ÿš€ Usage

Run the chat interface:

npm start

Follow the on-screen prompts to select a template and start chatting!

To provide multiline input, open the editor by submitting an empty input.

To return to the template selection, type exit.

Note

Context-aware sessions: The history of your chat session is sent back to OpenAI with every request. This ensures that the agent remains context-aware throughout the conversation to provide coherent responses.

When you exit a chat session, the history is dismissed. Each new session starts with a fresh interaction.

๐ŸŽจ Customization

Manage your chat agents in the templates directory:

templates/
โ”œโ”€โ”€ Customer Support.txt
โ”œโ”€โ”€ Developer.txt
โ”œโ”€โ”€ Final Cut Pro.txt
โ”œโ”€โ”€ Flynt Component.txt
โ”œโ”€โ”€ Meeting Notes.txt
โ”œโ”€โ”€ Titles.txt

Create a new chat agent by adding a text file with a prompt. The file name will be displayed in the selection.

Example

  1. Create a file named Code Documentation.txt in the templates directory with the following content:
Extend provided code with comments. Use clear and concise language.
  1. Start the script, and select the template Code Documentation.
  2. Open the editor, paste a code snippet, and the agent will generate code comments for your code.

๐Ÿ’ก Tips

Make the script available in any directory, by setting an alias in your .bashrc or .zshrc:

alias siegfried='(cd ~/your/path/siegfried-ai/ && npm start)'

The default editor can be changed via an environment variable:

export EDITOR="code -w"

For more information see Inquiry.js#Editor.

Maintainers

Steffen Bewersdorff

Contributing

To contribute, please use GitHub Issues and PRs.

License

MIT ยฉ 2023 Steffen Bewersdorff

siegfried-ai's People

Contributors

steffenbew avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  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.