elph

README

Elph - minimalist AI agent companion

[!WARNING] This project is under active development, so you may encounter bugs.
Please review the release notes thoroughly before updating, as breaking changes can occur!

Quick Start

You will need Go >= 1.26 installed. Optional: gotestsum and golangci-lint (installed via make prepare).

Read the CONTRIBUTING.md for detailed guidelines on contributing to this project.

Installation

Install using the install script:

curl -fsSL https://elph.space/install.sh | bash

Or use go install (requires Go 1.26+):

go install github.com/riipandi/elph/cmd/elph@latest

Up and Running

# Clone the repository
git clone <repository-url>
cd elph

# Install required toolchain
make prepare

# Install dependencies
make deps

# Run the application
make run

Documentation

Documentation lives in docs/. Start with docs/README.md.

License

This project licensed under the MIT license. See the LICENSE file for more information.

---

_{🤫 Psst! If you like my work you can support me via GitHub sponsors.}