{"id":13583429,"url":"https://github.com/progrium/topframe","last_synced_at":"2025-04-09T15:06:06.100Z","repository":{"id":54699447,"uuid":"346479982","full_name":"progrium/topframe","owner":"progrium","description":"Local webpage screen overlay for customizing your computing experience","archived":false,"fork":false,"pushed_at":"2021-04-15T22:08:31.000Z","size":8838,"stargazers_count":364,"open_issues_count":3,"forks_count":9,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-04-09T15:06:01.043Z","etag":null,"topics":["always-on-top","golang","html-css-javascript","html5","javascript","macos","overlay","overlay-window","webview"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/progrium.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"progrium"}},"created_at":"2021-03-10T20:13:56.000Z","updated_at":"2025-03-22T20:21:58.000Z","dependencies_parsed_at":"2022-08-14T00:20:44.792Z","dependency_job_id":null,"html_url":"https://github.com/progrium/topframe","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progrium%2Ftopframe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progrium%2Ftopframe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progrium%2Ftopframe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progrium%2Ftopframe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/progrium","download_url":"https://codeload.github.com/progrium/topframe/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248055284,"owners_count":21040157,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["always-on-top","golang","html-css-javascript","html5","javascript","macos","overlay","overlay-window","webview"],"created_at":"2024-08-01T15:03:28.340Z","updated_at":"2025-04-09T15:06:06.082Z","avatar_url":"https://github.com/progrium.png","language":"JavaScript","readme":"\u003cimg align=\"left\" alt=\"Topframe\" src=\"./topframe.png\" /\u003e\n\n# Topframe\nLocal webpage screen overlay\n\n\u003c!-- \u003ca href=\"https://goreportcard.com/report/github.com/progrium/topframe\" title=\"Go Report Card\"\u003e\u003cimg src=\"https://goreportcard.com/badge/github.com/progrium/topframe\" alt=\"Go Report Card\"\u003e\u003c/a\u003e --\u003e\n\u003ca href=\"https://twitter.com/progriumHQ\" title=\"@progriumHQ on Twitter\"\u003e\u003cimg src=\"https://img.shields.io/badge/twitter-@progriumHQ-55acee.svg\" alt=\"@progriumHQ on Twitter\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/progrium/topframe/discussions\" title=\"Project Forum\"\u003e\u003cimg src=\"https://img.shields.io/badge/community-forum-ff69b4.svg\" alt=\"Project Forum\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/sponsors/progrium\" title=\"Sponsor Project\"\u003e\u003cimg src=\"https://img.shields.io/static/v1?label=sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\" alt=\"Sponsor Project\" /\u003e\u003c/a\u003e\n\n---\n\u003cimg align=\"right\" width=\"320\" alt=\"Topframe Demo\" src=\"./topframe.gif\" /\u003e\n\n* Customize your computing experience with webdev\n* Display information and always-on-top widgets\n* Edit source, hit save, screen will update\n* Extensible with shell scripts in any language\n* Less than 400 lines of Go code, minimal deps\n* Currently alpha, macOS only ...\n\n## Getting Started\n\nYou can download from [Releases](https://github.com/progrium/topframe/releases) or with Homebrew you can:\n\n```\n$ brew install progrium/taps/topframe\n```\n\nIf you download a release zip make sure to unzip and put the binary in your PATH (like /usr/local/bin). \n\n```\n$ topframe -h\nUsage: topframe \u003cflags\u003e\nTopframe is a fullscreen webview overlay agent\n\nFlags:\n  -docs       open documentation in browser\n  -help       show help\n  -plist      generate launch agent plist\n  -version    show version\n```\n\nTo start it and show the demo webpage overlay, simply run `topframe`. This will also:\n\n* create a `~/.topframe` directory with a demo `index.html` used for the overlay\n* watch for file changes in `~/.topframe` to trigger a page reload\n* add a menu bar extra (🔲) to control the overlay\n\nIf you edit `~/.topframe/index.html` and hit save, changes will reflect immediately. If you hate the demo content of the default `index.html`, change it! Use **Show Source** from the menu extra to quickly\nopen your topframe directory.\n\n### Launching on Startup\n\nTopframe works with `launchd` to run as a background agent on startup. You can generate\nan agent plist file with `topframe -plist`, which you can write to a file in `~/Library/LaunchAgents`:\n\n```\n$ topframe -plist \u003e ~/Library/LaunchAgents/com.progrium.Topframe.plist\n```\n\nIt's a good idea to view the output before writing to the file, just to make sure\npaths are correct. If you don't know what is correct, it's probably fine!\n\n\n## Documentation\n\nThere is not a whole lot to Topframe! I recommend [reading the source](https://github.com/progrium/topframe/blob/main/topframe.go) as its only a few hundred lines,\nbut otherwise there is a [wiki](https://github.com/progrium/topframe/wiki) ready to document anything else.\n\n## Getting Help\n\nIf you're having trouble, be sure to check [issues](https://github.com/progrium/topframe/issues) to see if its a known issue. Otherwise, feel free to drop\na question into the [discussion forum](https://github.com/progrium/topframe/discussions).\n\n## Contributing\n\nIdeally, Topframe is kept small. Bug fixes and other small PRs are welcome and should be merged quickly.\nIf you happen to have a large PR that we haven't discussed, you should talk about it in the forum first. In order\nto keep the project small, some features suggestions may be held back in favor of determining a good extension point to expose instead.\n\n## About\n\nTopframe started as a 130 line example for [progrium/macdriver](https://github.com/progrium/macdriver).\n\nMIT Licensed","funding_links":["https://github.com/sponsors/progrium"],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprogrium%2Ftopframe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprogrium%2Ftopframe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprogrium%2Ftopframe/lists"}