Initial commit

Author: jonson

.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+name: golangci-lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  # pull-requests: read
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v7
+        with:
+          version: v2.0

.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Go Test
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+      - name: Build
+        run: go build -v ./...
+      - name: Test with the Go CLI
+        run: go test ./...

.gitignore

@@ -0,0 +1,28 @@
+# Added by goreleaser init:
+dist/
+
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env

.go-version

@@ -0,0 +1 @@
+1.24.2

.goreleaser.yaml

@@ -0,0 +1,55 @@
+# This is an example .goreleaser.yml file with some sensible defaults.
+# Make sure to check the documentation at https://goreleaser.com
+
+# The lines below are called `modelines`. See `:help modeline`
+# Feel free to remove those if you don't want/need to use them.
+# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
+# vim: set ts=2 sw=2 tw=0 fo=cnqoj
+
+version: 2
+
+project_name: tsgrok
+
+before:
+  hooks:
+    # You may remove this if you don't use go modules.
+    - go mod tidy
+
+builds:
+  - env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+      - windows
+      - darwin
+    main: ./cmd/tsgrok
+    binary: tsgrok
+
+archives:
+  - formats: [tar.gz]
+    # this name template makes the OS and Arch compatible with the results of `uname`.
+    name_template: >-
+      {{ .ProjectName }}_
+      {{- title .Os }}_
+      {{- if eq .Arch "amd64" }}x86_64
+      {{- else if eq .Arch "386" }}i386
+      {{- else }}{{ .Arch }}{{ end }}
+      {{- if .Arm }}v{{ .Arm }}{{ end }}
+    # use zip for windows archives
+    format_overrides:
+      - goos: windows
+        formats: [zip]
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"
+
+release:
+  footer: >-
+
+    ---
+
+    Released by [GoReleaser](https://github.com/goreleaser/goreleaser).

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch Package",
+            "type": "go",
+            "request": "launch",
+            "mode": "debug",
+            "program": "${workspaceFolder}/cmd/tsgrok",
+            "cwd": "${workspaceFolder}",
+            "debugAdapter": "dlv-dap",
+            "console": "integratedTerminal"
+        }
+    ]
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 jonson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

README.md

@@ -0,0 +1,72 @@
+# tsgrok ✨
+
+[![Go Report Card](https://goreportcard.com/badge/github.com/[your-username]/tsgrok)](https://goreportcard.com/report/github.com/[your-username]/tsgrok)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**Expose local http services using Tailscale via an interactive Terminal UI.**
+
+`tsgrok` provides a convenient way to create and inspect [ephemeral](https://tailscale.com/kb/1111/ephemeral-nodes) [Tailscale Funnels](https://tailscale.com/kb/1223/funnel) directly from your terminal.
+
+## Demo
+
+![tsgrok demo](docs/tsgrok.gif)
+
+
+## Why `tsgrok`?
+
+While the `tailscale funnel` command is powerful, managing multiple funnels is challenging.  `tsgrok` takes a different approach, creating a disposable ephemeral node in your tsnet for each funnel you create, and destrorying it when the app is closed.
+
+*   **Visibility:** See all your funnels and their status at a glance.
+*   **Ease of Use:** A dedicated TUI simplifies common actions like creation, deletion, and URL copying.
+*   **Request Inspection:** Quickly check if traffic is hitting your funnel without needing separate logging.
+*   **Disposable:** Each funnel is created on distinct ephemeral node, all of which live in memory and are destroyed when the app is terminated.  Orphaned ephemeral nodes are automatically cleaned up by Tailscale.
+
+## Requirements
+
+*   **Go:** Version 1.18 or higher (Update if you require a newer version).
+*   **Tailscale:** You need Tailscale installed, configured, and running on your machine. `tsgrok` interacts with your local Tailscale daemon.
+
+## Installation
+
+### Releases
+See the releases page for the latest releases.  Binaries are provided for major platforms.
+
+### Go
+The easiest way to install `tsgrok` is using `go install`:
+
+```bash
+go install github.com/jonson/tsgrok@latest
+```
+
+Make sure your Go environment variables (`GOPATH`, `GOBIN`) are set up correctly so the installed binary is in your system's `PATH`.
+
+## Usage
+
+Simply run the command:
+
+```bash
+tsgrok
+```
+
+## Tailscale Auth
+
+`tsgrok` is a standalone application that does not rely on Tailscale being installed on the machine running it.  Rather, it relies on an auth key to
+provision and manage ephemeral nodes.  You should provision an auth key, something like the following:
+
+![Tailscale Auth Key Configuration](docs/image.png)
+
+This must be set in the environment variable TSGROK_AUTHKEY, and it should be of the format `tskey-auth-...`.
+
+Flags to consider when creating your auth key:
+* Tags: You can automatically tag any nodes created by tsgrok, and add further restrictions in the ACL if desired.  Tags are not necessary however.
+* Ephemeral: `tsgrok` will only create ephemeral nodes, but you can toggle this to guarantee this is the case.
+* Reusable: This key nees to be reusable, else you will only be able to create one funnel!
+* Expiration: Set to whatever you desire.
+
+## Contributing
+
+Contributions are welcome! If you find a bug or have a feature request, please open an issue on GitHub. If you'd like to contribute code, please open a pull request.
+
+## License
+
+This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.

cmd/tsgrok/main.go

@@ -0,0 +1,77 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"sync"
+
+	tea "github.com/charmbracelet/bubbletea"
+	"github.com/joho/godotenv"
+	"github.com/jonson/tsgrok/internal/funnel"
+	"github.com/jonson/tsgrok/internal/tui"
+	"github.com/jonson/tsgrok/internal/util"
+)
+
+func main() {
+	serverErrorLog := util.NewServerErrorLog()
+
+	err := godotenv.Load()
+	if err != nil {
+		serverErrorLog.Println("Error loading .env file")
+	}
+
+	if util.GetAuthKey() == "" {
+		fmt.Printf("Missing env var %s, please set it and try again.\n", util.AuthKeyEnvVar)
+		os.Exit(1)
+	}
+
+	messageBus := &util.MessageBusImpl{}
+	funnelRegistry := funnel.NewFunnelRegistry()
+	httpServer := funnel.NewHttpServer(util.GetProxyHttpPort(), messageBus, funnelRegistry, serverErrorLog)
+
+	m := tui.InitialModel(funnelRegistry, serverErrorLog)
+
+	go func() {
+		err := httpServer.Start()
+		if err != nil {
+			// channel to send error to main thread
+			fmt.Fprintf(os.Stderr, "Error starting HTTP server: %v\n", err)
+		}
+	}()
+
+	cleanup := func() {
+		if len(funnelRegistry.Funnels) == 0 {
+			return
+		}
+
+		if len(funnelRegistry.Funnels) == 1 {
+			fmt.Printf("Closing tunnel\n")
+		} else {
+			fmt.Printf("Closing %d tunnels\n", len(funnelRegistry.Funnels))
+		}
+
+		var wg sync.WaitGroup
+		for _, f := range funnelRegistry.Funnels {
+			wg.Add(1)
+			go func(f funnel.Funnel) {
+				defer wg.Done()
+				err := f.Destroy()
+				// should we log it?
+				if err != nil {
+					fmt.Printf("Error destroying tunnel: %v\n", err)
+				}
+			}(f)
+		}
+		wg.Wait()
+	}
+	defer cleanup()
+
+	p := tea.NewProgram(m, tea.WithAltScreen())
+
+	messageBus.SetProgram(p)
+
+	if _, err := p.Run(); err != nil {
+		fmt.Println(err)
+	}
+
+}