An open API service indexing awesome lists of open source software.

https://github.com/layerdynamics/llm-pack


https://github.com/layerdynamics/llm-pack

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# LLM-Pack

LLM-Pack is a CLI tool with an optional GUI designed to optimize project files and datasets for consumption by Large Language Models (LLMs) and humans.

## Features

- **Recursive Indexing**
- **Ignore File Compliance**
- **File Consolidation**
- **Sorting Mechanism**
- **Configuration Support**
- **Optional GUI**
- **Extendable API**

## Plugin System

LLM-Pack supports plugins for extending its functionality. Place your plugins in the `plugins` folder with a `plugin.json` manifest. Refer to the [Plugin Development Guide](./docs/plugin-development.md) for details.

## Installation

Ensure you have [Node.js](https://nodejs.org/) installed (version 16.x or higher).

```bash
npm install -g llm-pack
```

## Usage

### CLI

```bash
llm-pack scan --config .llm-pack.config.json
```

### GUI

```bash
llm-pack gui
```

## Documentation

- [User Guide](./docs/user_guide.md)
- [Developer Guide](./docs/developer_guide.md)
- [API Reference](./docs/api/api_reference.md)

## Contributing

Contributions are welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md).

## License

This project is licensed under the MIT License. See [LICENSE](./LICENSE).