Flm-Companion

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 22 Open GitHub ↗

Flm Companion is a lightweight Windows desktop app that simplifies managing your local FastFlowLM CLI server. It offers an intuitive interface to start, stop, and monitor the LLM, manage models, and check updates without command line use.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 style="border: none;">🤖 Flm Compagnon</h1>

[![Requires FastFlowLM](https://img.shields.io/badge/Requires-FastFlowLM-red?style=flat-square&logo=github)](https://github.com/FastFlowLM/FastFlowLM)

[![GitHub release](https://img.shields.io/github/v/release/julienM77/flm-companion?style=flat-square&label=Version)](https://github.com/julienM77/flm-companion/releases)
[![Build](https://img.shields.io/github/actions/workflow/status/julienM77/flm-companion/main.yml?style=flat-square&label=Build)](https://github.com/julienM77/flm-companion/actions/workflows/main.yml)
[![License](https://img.shields.io/github/license/julienM77/flm-companion?style=flat-square)](https://raw.githubusercontent.com/julienM77/Flm-Companion/main/LICENSE)

[![Platform](https://img.shields.io/badge/Platform-Windows-blue?style=flat-square)](https://github.com/julienM77/flm-companion/releases)
[![Tauri](https://img.shields.io/badge/Built%20with-Tauri-blueviolet?style=flat-square&logo=tauri)](https://tauri.app)

</div>

## 📝 Description

Flm Compagnon is a modern GUI designed to accompany and manage the **FastFlowLM (FLM)** project. It offers a smooth user experience to interact with your local AI models, monitor the server, and manage your configurations.

> [!IMPORTANT]
> This application requires **[FastFlowLM (FLM)](https://github.com/FastFlowLM/FastFlowLM)** to be installed on your system. Without it, Flm Compagnon will not function.

## ✨ Features

* **Models**: Model manager (download, delete, inspect details).
* **Server**: Configuration and management of the FLM server instance.
* **Resource Monitor**: Real-time NPU and RAM usage monitoring with historical charts when server is running.
* **Presets**: Save and manage custom server configurations as presets for quick access.
* **System Tray**: Quick access to server controls, **model selection**, **presets**, and status directly from the notification area.
* **Auto-Updates**: Automatic update check at startup for both FLM Companion and FastFlowLM with integrated installer.
* **Auto-start**: Option to launch the application automatically at Windows startup.
* **Start Minimized**: Option to launch the application minimized to the system tray (configurable in settings).
* **Settings**: Application customization.
* **About**: View application version, hardware information, FLM changelog, and check for updates.
* **Multilingual**: Interface management in **English, French, and Japanese**.
* **Theme**: Management of light and dark themes.

## 📸 Videos

### 🗂️ Interface
![gif demo interface](https://raw.githubusercontent.com/julienM77/Flm-Companion/main/screen/demo_interface.gif)

### 🔔 System Tray
![gif demo systreay](https://raw.githubusercontent.com/julienM77/Flm-Companion/main/screen/demo_notif.gif)

## 📋 To do

<summary>Completed</summary>

* [X] Add NPU and RAM usage monitoring and display (real-time stats)
* [X] Clean code and optimisation
* [X] Fix the server management design for consistency
* [X] Add a version check for the companion application (+ changelog)
* [X] Add caching for the list of models, CPU version, and RAM
* [X] Force an update of the model list on the server configuration side when models are modified (DLL, delete)
* [X] Add menus to the notification area icon (server management, models)
* [X] Complete the translation of all texts for multilingual support
* [X] Flm update 0.9.21 → add the option to launch the server without a model using ASR for Whisper
* [X] Flm update 0.9.22 → add the option to launch the server with host parameters
* [X] Add a startup check when FLM is launched (verify model availability and server prerequisites)
* [X] Add an automatic update check at application startup with integrated installer
* [X] Finalize saving and loading of custom usage configuration (persist user presets)
* [X] Add preset management system (save, delete, and quick access to server configurations)
* [X] Display FLM changelog in About view
* [X] GitHub API rate limiting with caching to prevent 403 errors
* [X] Ensure "Run at startup" setting is preserved across updates and installer actions
* [X] Add an in-app memory / resource calculator for chosen model + server configuration
  
</details>

## 🤝 Contribution

This project is open-source and open to contributions! Feel free to propose improvements via **Pull Requests** or report issues.

## 🚀 Installation and Development

To run the project in development mode, you will need [Rust](https://www.rust-lang.org/) and [Node.js](https://nodejs.org/).

1. Install JavaScript dependencies:

```bash
    npm install
    ```

2. Run the application in development mode:

```bash
    npm run tauri dev
    ```

To build the project in release mode, you will need [Rust](https://www.rust-lang.org/) and [Node.js](https://nodejs.org/).

1. Install JavaScript dependencies:

```bash
    npm install
    ```

2. Build the application in release mode:

```bash
    npm run tauri build
    ```

Flm-Companion

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README