Metadata-Version: 2.4
Name: solan
Version: 1.2.0
Summary: Share your files. Everywhere.
Keywords: solan,share,sharing,lan
Author: Francesco Apruzzese
Author-email: Francesco Apruzzese <cescoap@gmail.com>
License-Expression: AGPL-3.0-or-later
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Communications :: File Sharing
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Requires-Dist: click
Requires-Dist: pyngrok
Requires-Python: >=3.8
Project-URL: Homepage, https://github.com/OpenCode/solan
Description-Content-Type: text/markdown

# Share your files. Everywhere.

Solan is a multi-system command-line software, written in Python, used to share files from a local computer.

When a directory is shared with Solan, every browser (or similar) can be used to navigate files and download them.Solan is a simple and basic system to share files with other people in the same net

## Installation

### Linux

Install Solan from Pypi

    $ pipx install solan

or install Solan as a command-line tool with [uv](https://docs.astral.sh/uv/)

    $ uv tool install solan

or run it without installing

    $ uvx solan [path_to_share]

### Others

Download the installer for your system from the [latest release](https://github.com/OpenCode/solan/releases/latest):

- **Windows**: `solan-<version>-windows-setup.exe` installs Solan for the current user and adds it to the PATH.
- **macOS** (Apple Silicon): `solan-<version>-macos-arm64.pkg` installs Solan in `/usr/local/bin`.

The installers are not signed yet: Windows SmartScreen may ask to confirm ("More info" → "Run anyway"),
and on macOS you may need to right-click the `.pkg` and choose "Open".

## Development

    $ git clone https://github.com/OpenCode/solan.git && cd solan
    $ uv sync
    $ uv run solan [path_to_share]

## Usage

### Linux and MacOS

    $ solan [path_to_share]

and then open your browser and visit the url printed in your terminal

### Windows

Right-click a folder (or the empty area inside it) and choose **Share with Solan** — on Windows 11 it's under "Show more options".
A window opens with the address to share; close it to stop sharing.
You can also open a new terminal and run `solan`.

## Examples:

    $ solan /tmp

or you can define a different port (standard is 8000)

    $ solan ~/Example/Share -p 8004

## Remote access

Enable remote with -r parameter


    $ solan -r /tmp

## In action

![solan dark Mode](https://raw.githubusercontent.com/OpenCode/solan/master/readme/solan-dark.png "Solan Dark Mode")

![solan light Mode](https://raw.githubusercontent.com/OpenCode/solan/master/readme/solan-light.png "Solan Light Mode")

## Support

<a href="https://www.buymeacoffee.com/scapigliato" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/arial-black.png" alt="Buy Me A Coffee" style="height: 51px !important;width: 217px !important;" ></a>

<a href="https://liberapay.com/Scapigliato/donate" target="_blank"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg" style="height: 51px !important;width: 217px !important;"></a>
