Metadata-Version: 2.4
Name: lrok
Version: 0.3.2
Summary: Expose local services with readable tunnel names
Home-page: https://github.com/lum-tools/lrok
Author: lum.tools
Author-email: ops@lum.tools
License: MIT
Project-URL: Bug Tracker, https://github.com/lum-tools/lrok/issues
Project-URL: Platform, https://platform.lum.tools
Project-URL: Dashboard, https://platform.lum.tools/tunnels
Project-URL: Blog, https://blog.lum.tools
Project-URL: Homepage, https://platform.lum.tools
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Internet
Classifier: Topic :: System :: Networking
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
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: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-python
Dynamic: summary

# lrok - Tunnel Service by lum.tools

Expose your local services to the internet with HTTPS and readable URLs.

```bash
lrok 8000
# → https://happy-dolphin.t.lum.tools
```

## Installation

```bash
pip install lrok
```

## Quick Start

1. Get your API key from [platform.lum.tools/keys](https://platform.lum.tools/keys)
2. Login with your API key:
   ```bash
   lrok login lum_your_api_key
   ```
3. Start a tunnel:
   ```bash
   lrok 8000
   ```

## Features

- **HTTP/TCP/STCP/XTCP tunnels** - Multiple protocols for different use cases
- **Reserved subdomains** - Claim permanent URLs that only you can use
- **Built-in request inspector** - Web dashboard at localhost:4242
- **Automatic HTTPS** - All tunnels secured with valid SSL certificates

## Subdomain Management

Reserve permanent tunnel URLs (up to 5 per user):

```bash
# List your reserved subdomains
lrok subdomains list

# Reserve a subdomain
lrok subdomains reserve my-app

# Release a subdomain
lrok subdomains delete my-app
```

## Documentation

Full documentation: [github.com/lum-tools/lrok](https://github.com/lum-tools/lrok)

## Links

- Platform: [platform.lum.tools](https://platform.lum.tools)
- Dashboard: [platform.lum.tools/tunnels](https://platform.lum.tools/tunnels)
- Subdomain Management: [lrok.lum.tools/subdomains](https://lrok.lum.tools/subdomains)
- Blog: [blog.lum.tools](https://blog.lum.tools)
- GitHub: [github.com/lum-tools/lrok](https://github.com/lum-tools/lrok)

## License

MIT

