@rubriclab/bunl 0.1.25 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.env.example CHANGED
@@ -1,3 +1,4 @@
1
1
  PORT=1234
2
2
  SCHEME=https
3
- DOMAIN=example.so
3
+ DOMAIN=bunl.sh
4
+ HOST=localhost
@@ -0,0 +1,16 @@
1
+ name: Release Package
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+
8
+ permissions:
9
+ contents: read
10
+ packages: write
11
+ id-token: write
12
+
13
+ jobs:
14
+ release:
15
+ uses: rubriclab/package/.github/workflows/release-package.yml@main
16
+ secrets: inherit
@@ -0,0 +1,16 @@
1
+ {
2
+ "[json]": {
3
+ "editor.defaultFormatter": "biomejs.biome"
4
+ },
5
+ "[typescript]": {
6
+ "editor.defaultFormatter": "biomejs.biome"
7
+ },
8
+ "[typescriptreact]": {
9
+ "editor.defaultFormatter": "biomejs.biome"
10
+ },
11
+ "editor.codeActionsOnSave": {
12
+ "source.fixAll.biome": "always"
13
+ },
14
+ "editor.defaultFormatter": "biomejs.biome",
15
+ "editor.formatOnSave": true
16
+ }
package/CHANGELOG.md ADDED
@@ -0,0 +1,3 @@
1
+ - [2026-02-06] [Bump version](https://github.com/rubriclab/bunl/commit/0043caed41428d060517223cbb8d72fe52813692)
2
+ # Changelog
3
+
package/Dockerfile CHANGED
@@ -1,15 +1,13 @@
1
- FROM oven/bun:1 as base
1
+ FROM oven/bun:1.3-slim AS base
2
2
 
3
3
  WORKDIR /app
4
4
 
5
- COPY package.json /app/
6
- COPY bun.lockb /app/
7
-
5
+ COPY package.json bun.lock ./
8
6
  RUN bun install --frozen-lockfile --production
9
7
 
10
- COPY . /app
8
+ COPY . .
11
9
 
12
- ENV NODE_ENV production
13
- ENTRYPOINT ["bun", "server"]
10
+ ENV NODE_ENV=production
11
+ EXPOSE 1234
14
12
 
15
- EXPOSE 1234
13
+ ENTRYPOINT ["bun", "run", "server.ts"]
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) 2024 Rubric Labs Inc
3
+ Copyright (c) 2026 Rubric Labs Inc
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,78 +1,26 @@
1
1
  # bunl
2
2
 
3
- ## A Bun WebSocket re-write of LocalTunnel
4
-
5
- ### Usage
6
-
7
- To try it:
8
-
9
- ```bash
10
- bun x bunl -p 3000 -d dev.rubric.me -s my-name
11
- ```
12
-
13
- ### Development
14
-
15
- To install dependencies:
16
-
17
- ```bash
18
- bun i
19
- ```
20
-
21
- To run the server:
22
-
23
- ```bash
24
- bun dev:server
25
- ```
26
-
27
- (Optional) to run a dummy process on localhost:3000:
3
+ Expose localhost to the world. Bun-native WebSocket tunnel.
28
4
 
29
5
  ```bash
30
- bun demo
6
+ bun x bunl -p 3000
31
7
  ```
32
8
 
33
- To run the client:
9
+ ## Options
34
10
 
35
- ```bash
36
- bun client -p 3000
37
- ```
11
+ | Flag | Short | Default | Description |
12
+ | --- | --- | --- | --- |
13
+ | `--port` | `-p` | `3000` | Local port to expose |
14
+ | `--domain` | `-d` | `bunl.sh` | Tunnel server |
15
+ | `--subdomain` | `-s` | random | Requested subdomain |
16
+ | `--open` | `-o` | `false` | Open URL in browser |
38
17
 
39
- With full args:
18
+ ## Development
40
19
 
41
20
  ```bash
42
- bun client --port 3000 --domain example.so --subdomain my-subdomain --open
43
- ```
44
-
45
- Or in shortform:
46
-
47
- ```bash
48
- bun client -p 3000 -d example.so -s my-subdomain -o
49
- ```
50
-
51
- The options:
52
-
53
- - `port` / `p` the localhost port to expose eg. **3000**
54
- - `domain` / `d` the hostname of the server Bunl is running on eg. **example.so**
55
- - `subdomain` / `s` the public URL to request eg. **my-subdomain**.example.so
56
- - `open` / `o` to auto-open your public URL in the browser
57
-
58
- ### [WIP] Deployment
59
-
60
- To build the client code:
61
-
62
- ```bash
63
- bun run build
64
- ```
65
-
66
- To deploy the server, for example on [Fly](https://fly.io):
67
-
68
- ```bash
69
- fly launch && fly deploy
70
- ```
71
-
72
- Making sure to set `DOMAIN` to your domain:
73
-
74
- ```bash
75
- fly secrets set DOMAIN=example.so
21
+ bun i
22
+ bun dev:server # tunnel server on :1234
23
+ bun demo # demo app on :3000
24
+ bun client # connect demo to server
25
+ bun test:e2e # end-to-end tests
76
26
  ```
77
-
78
- Open to PRs!
package/biome.json ADDED
@@ -0,0 +1,3 @@
1
+ {
2
+ "extends": ["@rubriclab/config/biome"]
3
+ }