Skip to content

Repository files navigation

Starcat uTools Plugin

Starcat

Official uTools plugin for searching Starcat local repositories and GitHub.

Starcat is a native macOS app that turns GitHub Stars into a searchable, organized and AI-assisted local knowledge base, with a broader ecosystem of desktop clients, plugins, CLI tools, and self-hostable services.

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:

Official uTools plugin for searching Starcat local repositories and GitHub.

中文说明

CI License

What it does

Open the Starcat command in uTools and type a repository keyword. The result list preserves Starcat's search ordering and shows:

  • repository owner/name;
  • source attribution: Starcat Local or GitHub;
  • primary language, star count, and description;
  • the public owner or organization avatar.

Press Return to open a local result in Starcat through its constrained deep link. A GitHub-only result opens on github.com.

Architecture

The plugin is a thin launcher adapter:

uTools list
  -> starcat search
  -> starcat.global_search_repos
  -> Starcat Local FTS + GitHub Search

It never reads the Starcat database, Keychain, local API key, pairing profile, or GitHub token. Search, ranking, deduplication, authentication, and Starcat Pro entitlement checks remain in Starcat and the CLI.

Requirements

  • macOS;
  • uTools with template list plugin support;
  • Starcat with the MCP service enabled;
  • an active Starcat Pro entitlement;
  • Starcat CLI v1.1.0 or newer, paired with Starcat.

Install the CLI with Homebrew:

brew install starcat-app/starcat-cli/starcat
starcat pair
starcat doctor

The plugin locates starcat from PATH, /opt/homebrew/bin, /usr/local/bin, or ~/.local/bin. Developers can set an absolute STARCAT_CLI_PATH.

Development

The runtime uses readable CommonJS and Node built-ins only. There are no runtime npm dependencies.

npm ci
npm run verify

To run in uTools:

  1. Install uTools and its Developer Tools plugin.
  2. Choose this repository's plugin.json.
  3. Enter the Starcat command.
  4. Search for a repository.

The first version always searches both local and GitHub sources. Source selection can be added later without moving search logic into this plugin.

Tests

Tests cover CLI path resolution, argv safety, contract decoding, stable error codes, URL allowlists, result presentation, cancellation, timeout, debounce, and stale-result protection.

The test fixtures are copied from the versioned source in starcat-cli/contracts/global-search.

Packaging and release

scripts/verify-package.sh validates the source package but does not generate an installable file.

UPXS packages must be generated manually through uTools Developer Tools. The first public Marketplace release will use version 1.0.0; repository development starts at 0.1.0. See RELEASING.md.

Privacy, security, and support

License

MIT. See LICENSE.

About

Official uTools plugin for searching Starcat local repositories and GitHub.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages