Skip to content

starcat-app/starcat-chrome-plugin

Repository files navigation

Starcat Chrome Plugin

Starcat

Chrome/Chromium companion extension that brings Starcat context to GitHub pages.

Starcat is a native macOS app that turns GitHub Stars into a searchable, organized and AI-assisted knowledge base. It supports README rendering, tags, private notes, release tracking, repository health signals, AI summaries, semantic search, browser plugin workflows and self-hostable support APIs.

Install with Homebrew
中文说明

website support homebrew localization
Starcat main window

Preferred install method:

brew tap starcat-app/starcat
brew trust starcat-app/starcat
brew install --cask starcat

Useful links:

Self-hostable support APIs:

Starcat Chrome Plugin enhances GitHub repository pages and Google search results with context already stored in Starcat. It can show local Starcat entry points and Health information for starred GitHub repositories without directly accessing the GitHub API, Starcat backends, OpenSSF, or an AI provider.

Features

  • Show similar repository recommendations on GitHub repository pages.
  • Link to known Wiki providers.
  • Read and save private Starcat notes.
  • Display Health and OpenSSF scores cached by Starcat.
  • Trigger CodeFlow and Codebase actions in the Starcat app.
  • Add Open in Starcat and Health badges to starred GitHub repositories in Google search results.

Load Locally

  1. Open chrome://extensions/ in Chrome.
  2. Enable Developer mode.
  3. Click Load unpacked.
  4. Select supports/extensions/starcat-chrome-plugin.
  5. In Starcat, open Settings → Integrations → Browser Plugin and enable the service. Then open Settings → Integrations → Local API Key and copy the key.
  6. Left-click the Starcat toolbar icon and enter the endpoint port and Local API Key in the popup.
  7. Click Test.

The full configuration page remains available through Open full options in the popup.

Communication Boundary

The extension communicates only with the local HTTP service exposed by the Starcat app:

http://127.0.0.1:{port}/plugin/v1

Every business request requires:

Authorization: Bearer <local-api-key>

The Starcat Local API Key authorizes only the local loopback interface. It is not a GitHub token, AI key, or Starcat backend API key.

Repository Layout

Path Purpose
manifest.json Chrome MV3 entry manifest.
LICENSE Open-source license.
PRIVACY.md Privacy and data-boundary documentation.
SECURITY.md Security boundaries and vulnerability reporting.
CONTRIBUTING.md Local development and contribution guidelines.
CHANGELOG.md Version history.
src/shared/shared.js Configuration storage, GitHub repository URL parsing, and local API client.
src/popup/ Quick-pairing popup shown when the toolbar icon is left-clicked.
src/options/ Endpoint port, Local API Key, and connection testing.
src/content/ Page injection and rendering for GitHub repositories and Google search results.
docs/ Store submission materials, privacy disclosures, review notes, and asset requirements.

Release Materials

Read docs/README.md before preparing a store release. The documents follow the current source behavior, especially the permissions used on Google search pages, Local API Key pairing, and the local Companion API data boundary.

Validation

python3 -m json.tool supports/extensions/starcat-chrome-plugin/manifest.json >/dev/null
node --check supports/extensions/starcat-chrome-plugin/src/shared/shared.js
node --check supports/extensions/starcat-chrome-plugin/src/popup/popup.js
node --check supports/extensions/starcat-chrome-plugin/src/options/options.js
node --check supports/extensions/starcat-chrome-plugin/src/content/content-script.js

About

Chrome and Chromium companion extension for bringing Starcat repository context and health insights to GitHub and Google Search.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors