LLM4S Giter8 Template

Official Giter8 template for creating LLM4S projects.

Usage

Create a new LLM4S project

To create a new project using the latest template version:

sbt new llm4s/llm4s.g8

You will be prompted for various parameters:

• name: Project name (default: llm4s-template)
• package: Package name (default: org.llm4s.template)
• version: Initial project version (default: 0.1.0-SNAPSHOT)
• llm4s_version: LLM4S library version (default: 0.4.0)
• scala_version: Scala version (default: 3.7.1)
• java_version: Java version (default: 21)
• munit_version: Munit testing library version (default: 1.1.1)

Using a specific template version

To use a specific version of the template:

sbt new llm4s/llm4s.g8.git#v1.0.0

Non-interactive mode

You can also provide parameters directly:

sbt new llm4s/llm4s.g8 \
  --name=my-llm-project \
  --package=com.example.llm \
  --llm4s_version=0.4.0 \
  --scala_version=3.7.1 \
  --java_version=21 \
  --munit_version=1.1.1

Template Features

This template creates a complete LLM4S project with:

• ✅ Pre-configured build.sbt depending on the published org.llm4s %% llm4s-core artifact
• ✅ application.conf with a named provider wired to environment variables via Llm4sConfig
• ✅ Example application demonstrating LLM4S usage
• ✅ Test setup with Munit
• ✅ Scalafmt configuration
• ✅ GitHub Actions CI/CD workflows
• ✅ Environment configuration support
• ✅ Pre-commit hooks for code quality

Project Structure

my-llm-project/
├── .github/
│   └── workflows/
│       └── ci.yml           # CI/CD configuration
├── src/
│   ├── main/
│   │   ├── resources/
│   │   │   └── application.conf  # llm4s named-provider configuration
│   │   └── scala/
│   │       └── com/example/
│   │           ├── Main.scala          # Example application
│   │           └── PromptExecutor.scala # Prompt execution against llm4s
│   └── test/
│       └── scala/
│           └── com/example/
│               ├── MainSpec.scala           # Configuration smoke tests
│               └── PromptExecutorSpec.scala # Stub-client behaviour tests
├── .env.<name>               # Environment variables template
├── .gitignore
├── .scalafmt.conf           # Code formatting rules
├── build.sbt                # SBT build configuration
├── project/
│   └── build.properties
└── README.md                # Project documentation

Version Compatibility

Template Version	LLM4S Versions	Scala Versions
1.1.x	0.4.x (default 0.4.0)	3.7.1
1.0.x	0.1.0 - 0.1.x (artifact no longer published)	2.13.16, 3.7.1

LLM4S 1.0 targets Scala 3 only; see COMPATIBILITY.md.

Development

Running Tests

To test the template locally:

sbt test

This will:

1. Generate a project from the template into target/sbt-test/llm4s.g8/scripted
2. Run sbt clean scalafmtCheckAll test inside the generated project

If the template stops compiling, or its LLM4S dependency stops resolving, this command fails.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This template is licensed under the MIT License - see the LICENSE file for details.

Support

For issues, questions, or contributions, please visit:

• Template Repository
• LLM4S Framework
• Documentation