locadot
Version:
Secure your local development environment with HTTPS and custom domains like dev.localhost.
139 lines (85 loc) β’ 2.59 kB
Markdown
# locadot π
## β¨ Features
- β
Automatically generates trusted local SSL certificates
- π Reverse proxies `localhost:PORT ` β `https://your.custom.domain.localhost`
- π₯οΈ Works on Windows, macOS, and Linux
- π οΈ OS-specific guidance for host setup
- β οΈ Warns and exits if domain isnβt correctly mapped to a local IP
- β Only supports proxying to localhost ports β external IPs are not allowed for security
---
## π Usage
```bash
npx locadot add --host dev.localhost --port 3350
```
---
## π¦ Commands
##### βΆοΈ Default (Run Proxy)
###### Starts a reverse proxy to the specified localhost port.
```bash
npx locadot add --host <custom.localhost> --port <localhost-port>
```
##### π§Ύ Update existing host
###### Update domains currently registered with locadot.
```bash
npx locadot update --host <your.localhost> --port <localhost-port>
```
##### π§Ύ Remove existing host
###### Remove domains currently registered with locadot.
```bash
npx locadot remove --host <your.localhost>
```
##### π§Ύ View Registered Hosts
###### Displays all domains currently registered with locadot.
```bash
npx locadot host
```
##### πΊ Watch Logs
###### Continuously watches and outputs proxy logs in real time.
```bash
npx locadot watch:logs
```
##### π§Ή Clear Logs
###### Clears all saved logs.
```bash
npx locadot clear:logs
```
##### π§Ή Clear Hosts
###### Clears all existing hosts.
```bash
npx locadot clear:hosts
```
##### π§Ή Show Config Path
###### Print the path of config files used.
```bash
npx locadot path
```
##### π§Ή Show Logs Path
###### Print the path of logged files used.
```bash
npx locadot path:logs
```
##### π§Ή Show Hosts Path
###### Print the path of hosts files used.
```bash
npx locadot path:hosts
```
##### π Restart Proxy
###### Restarts the proxy server and reloads configuration.
```bash
npx locadot restart
```
##### π Stop All
###### Stops all running locadot hosts and shuts down the proxy server.
```bash
npx locadot stop
```
##### π Kill
###### Stops all running locadot hosts, clear logs and host mapping and shuts down the proxy server.
```bash
npx locadot kill
```
---
### π Contributing:
Pull requests are welcome! Feel free to open issues for bugs or feature requests. Contributions help improve locadot for everyone, so don't hesitate to get involved.
---
##### Made with β€οΈ to make secure local development simple.