Skip to content

ITx-prash/floweave

Repository files navigation

Floweave Text
Floweave Flow


Floweave is a lightweight terminal utility that extends your Linux desktop to a virtual display, allowing you to use any device as a wireless second monitor via VNC.

✨ Features

  • Wireless Display: Extend your Xorg desktop to any device using VNC.
  • Configurable Output: Adjust resolution, position, and scaling as needed.
  • Interactive CLI: Clean, intuitive terminal interface for managing sessions.
  • No Cables Required: Works seamlessly over your local WiFi network.

📋 Requirements

  • Linux with an Xorg (X11) session — Wayland is not supported
  • Both your laptop and second device on the same WiFi network
  • A VNC client app on your second device — e.g. AVNC (Android), RealVNC Viewer (iOS/Android/desktop)

🚀 Installation

Quick Start

  1. Clone the repository:

    git clone https://github.com/ITx-prash/floweave.git
    cd floweave
  2. Run the installer:

    ./install.sh

    The installer automatically handles all required dependencies.

  3. Launch Floweave:

    floweave
  4. Connect your device: Open your VNC client app, enter the IP address and port shown by Floweave (e.g. 192.168.1.x:5900), and connect.

Important

If the floweave command is not found, restart your terminal or run source ~/.bashrc (or your shell's config file) to update your PATH.

📖 Usage

Floweave offers both a rich interactive menu and a fast command-line interface.

Interactive Menu

Simply run floweave to open the main dashboard:

floweave

From here, you can start/stop the service, configure settings, and view connection details.

Command Line Interface

For fast operations and scripting:

Command Description
floweave start Start the virtual display and VNC server
floweave stop Stop the server and remove the virtual display
floweave config Open the configuration wizard
floweave help Show help information
floweave version Display current version

Uninstall

To remove Floweave from your system:

rm -rf ~/.local/share/floweave
rm ~/.local/bin/floweave

Coder illustration
Crafted with 💚 on GNU/Linux
Copyright © 2025-present Prashant Adhikari

About

Floweave is a personal Linux CLI project for creating virtual displays and streaming them over VNC.

Topics

Resources

Stars

Watchers

Forks

Contributors

Languages