Skip to content

Navigation Menu

Sign in
Sign up

Repository files navigation


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 Linux desktop to any device using VNC.
  • Display Server Support: Works on both Xorg (X11) and GNOME Wayland.
  • 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 or GNOME Wayland session (GNOME 40+ with Mutter)

    [!NOTE] Wayland support is currently limited to GNOME. Other Wayland compositors (such as KDE Plasma, Hyprland, and Sway) are not supported.

  • Both your laptop and second device on the same WiFi network
  • A VNC client app on your second device (such as AVNC for Android, or RealVNC Viewer for 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. Start Floweave:

    floweave --start

    Or run floweave to open the interactive dashboard and select Start 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 Start the virtual display and VNC server
floweave --stop / stop Stop the server and remove the virtual display
floweave --config / config Open the configuration wizard
floweave --help / 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 Linux CLI project for creating virtual displays and streaming them over VNC.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Contributors

Languages

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /