Metadata-Version: 2.4
Name: rbrowser
Version: 0.1.16
Summary: Launch RBrowser with a local or remote (SSH) directory as a file server
Author: RBrowser Team
License: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: click>=8.0
Requires-Dist: flask>=2.0
Requires-Dist: flask-cors>=4.0

Command-line tool for serving local or SSH-accessible data folders and opening them in RBrowser. The frontend UI is bundled inside the wheel — one `pip install`, no Node.js required.

# Install

```
pip install rbrowser
rbrowser open .
rbrowser open user@server:/data/projects
```

## Usage

```text
rbrowser open <path> [options]

Arguments:
  path                       local directory or user@host:/remote/path

Options:
  -p, --port <port>          port to bind (default: random free port)
  --frontend <url>           RBrowser frontend URL, or "bundled". Default: bundled.
  --host <addr>              bind address for the file server (default: 0.0.0.0)
  --public                   force the printed URL to use this machine's LAN/public hostname
  --localhost                force the printed URL to use 'localhost' (for ssh -L tunneling)
  --token <token>            auth token (default: random). Use --no-token to disable auth.
  --no-token                 disable token authentication (NOT recommended on shared hosts)
  --help                     show help
```

## Examples

```
# Local
rbrowser open .
rbrowser open ~/projects

# Remote (uses your local ssh client + ~/.ssh/config)
rbrowser open me@gpu-box:/data/exp42

# In a tmux/ssh session, force LAN URL so you can paste it in your laptop browser
rbrowser open . --public

# Use a tunnel (ssh -L 8765:localhost:8765) and pin the printed URL to localhost
rbrowser open . --localhost --port 8765

# Disable auth (only inside trusted networks!)
rbrowser open . --no-token
```

## Requirements

- Python >= 3.8
- For remote paths: `ssh` available on PATH and key-based auth set up to the target host. Remote shell must support standard POSIX `cd`, `stat`, `dd`, `cat`, `mkdir`, `mv`, `rm`, `touch`.
