Starcat Documentation

Official documentation for Starcat, covering setup, GitHub Stars management, AI features, RAG knowledge base, and integrations.

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.

_中文说明

Preferred install method:

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

Useful links:

• Home and downloads: https://starcat.ink
• Public support and release notes: https://github.com/starcat-app/starcat-pro
• Starcat App Homebrew tap: https://github.com/starcat-app/homebrew-starcat
• CLI / MCP: starcat-cli / Homebrew tap
• AI Agent Skill: https://github.com/starcat-app/starcat-skill
• Browser plugins: Chrome / Safari
• Documentation: https://github.com/starcat-app/starcat-docs
• Website source: https://github.com/starcat-app/starcat-site
• Localization: https://github.com/starcat-app/starcat-localization

Self-hostable support APIs:

• starcat-sharing-api
• starcat-trending-api
• starcat-weekly-api
• starcat-wiki-api
• starcat-recommend-api
• starcat-discovery-api

This repository contains the official user documentation for Starcat. The documentation is built with Mintlify and published at starcat.mintlify.site.

Documentation Scope

• Installation, first launch, and GitHub connection.
• GitHub Stars organization, search, tags, notes, and smart collections.
• AI summaries, translation, chat, and provider configuration.
• Knowledge Base RAG workflows, indexing, sessions, and citations.
• Release subscriptions, discovery, browser plugins, CLI, settings, and data privacy.
• Troubleshooting and frequently asked questions.

The documentation is currently written primarily in Simplified Chinese because it serves Starcat's current product audience and interface.

Repository Structure

getting-started/   Installation and onboarding
manage-stars/     Star organization workflows
ai-features/      AI features and configuration
knowledge-base/   Knowledge Base RAG workflows
release/          Release tracking and notifications
settings/         Application settings
docs.json         Mintlify navigation and site configuration

Local Preview

Install the Mintlify CLI:

npm install --global mint

Start the local documentation server from the repository root:

mint dev

The preview is available at http://localhost:3000 by default.

Before submitting documentation changes, run:

mint validate
mint broken-links

Contributing and Support

Documentation corrections and focused improvements are welcome through pull requests. Keep navigation changes synchronized with docs.json, do not include credentials or private user data, and attach only sanitized screenshots.

• Documentation repository issues: https://github.com/starcat-app/starcat-docs/issues
• Starcat product support: https://github.com/starcat-app/starcat-pro/issues
• Security reports: https://github.com/starcat-app/starcat-docs/security/advisories/new

License

This documentation repository is available under the MIT License.