Installation

Install the Exposr CLI on your machine.

Requirements

Python 3.10 or later
pip (Python package manager)
An internet connection
A local TCP service to expose

Install from source

Clone the repository and install the package:

bash

git clone https://github.com/Hrick-08/Exposr.git
cd Exposr
python -m pip install .

This installs the exposr command globally via the client.main:main entry point.

Development installation

For development, use an editable installation so source changes take effect immediately:

bash

python -m pip install -e .

Windows PATH setup

On Windows, the exposr executable may be installed in a directory not on your PATH. If you see:

text

'exposr' is not recognized as an internal or external command

Find your Python user base directory and add its Scripts folder to PATH:

bash

python -m site --user-base
# Add the Scripts directory inside that location to PATH

# Verify
where exposr

After updating PATH, open a new terminal window.

Verify installation

Run the following to verify Exposr is installed:

bash

exposr expose 3000

Note

If you haven't configured a server yet, Exposr will show an error asking you to run exposr config set-server <server-ip>. This is expected — see the Quick Start guide.

How Exposr Works Quick Start

Edit this page on GitHub →