Skip to content

yym68686/Cerebr

Repository files navigation

Chrome Web Store

English | Simplified Chinese

๐Ÿง  Cerebr - Intelligent AI Assistant

screenshot

The name "Cerebr" comes from a Latin root related to "brain" or "cerebrum". This etymology reflects our vision: to integrate powerful AI capabilities from Claude, OpenAI, and others, making Cerebr your second brain for deep reading and understanding. Cerebr is a powerful Chrome browser AI assistant extension focused on enhancing your work efficiency and learning experience.

Born from a need for a clean, efficient browser AI assistant, Cerebr stands out with its minimalist design and powerful features. While other solutions often come with limitations or cluttered interfaces, Cerebr focuses on delivering a seamless, distraction-free experience for your web browsing needs.

โœจ Core Features

  • ๐ŸŽฏ Smart Sidebar - Quick access via hotkey (Windows: Alt+Z / Mac: Ctrl+Z) to chat with AI anytime, anywhere
  • ๐Ÿ”„ Multiple API Support - Configure multiple APIs to flexibly switch between different AI assistants
  • ๐Ÿ” Config Sync - Cross-browser API configuration synchronization for seamless device switching
  • ๐Ÿ“ Comprehensive Q&A - Support webpage content Q&A, PDF document Q&A, image Q&A and more
  • ๐ŸŽจ Elegant Rendering - Perfect support for Markdown text rendering and LaTeX math formula display
  • โšก Real-time Response - Stream output for instant AI replies
  • โน๏ธ Flexible Control - Support stopping generation at any time, sending new messages will stop the current generation
  • ๐ŸŒ“ Theme Switching - Support light/dark themes to protect your eyes
  • ๐ŸŒ Web Version - Support web version, no installation required, accessable from any browser, support vercel, GitHub Pages and cloudflare pages deployment

๐Ÿ› ๏ธ Technical Features

  • ๐Ÿ’พ State Persistence - Automatically save chat history, sidebar status, etc.
  • ๐Ÿ”„ Config Sync - Cross-device configuration sharing through browser's native sync API
  • ๐Ÿ” Smart Extraction - Automatically identify and extract webpage/PDF content
  • โŒจ๏ธ Shortcut Operations - Support hotkey to clear chat (Windows: Alt+X / Mac: Ctrl+X), up/down keys for quick history recall
  • ๐Ÿ”’ Secure & Reliable - Support multiple API key management with local data storage
  • ๐ŸŽญ High Compatibility - Support mainstream browsers, adapt to various webpage environments

๐ŸŽฎ User Guide

  1. ๐Ÿ”‘ Configure API

    • Click the settings button
    • Fill in API Key, Base URL and model name
    • Support adding multiple API configurations
  2. ๐Ÿ’ฌ Start Chatting

    • Use hotkey Windows: Alt+Z / Mac: Ctrl+Z to summon sidebar
    • Input questions and send
    • Support image upload for visual Q&A
  3. ๐Ÿ“š Webpage/PDF Q&A

    • Enable webpage Q&A switch
    • Automatically identify and extract current page content
    • Support intelligent PDF file Q&A

๐Ÿ”ง Advanced Features

  • ๐Ÿ“‹ Right-click Copy - Support right-click to directly copy message text
  • ๐Ÿ”„ History Records - Use up/down arrow keys to quickly recall historical questions
  • โน๏ธ Stop Generation - Show stop button when generating messages, can stop generation at any time
  • ๐Ÿ–ผ๏ธ Image Preview - Click images to view full size
  • โš™๏ธ Custom Settings - Support customizing hotkeys, themes and more

๐Ÿš€ Web Version Deploy

  1. You can quickly deploy the web version of Cerebr to Vercel with one click:

Deploy with Vercel

  1. You can deploy to Cloudflare Pages:
# Install Wrangler CLI
npm install -g wrangler

# Login to Cloudflare
wrangler login

# Deploy to Cloudflare Pages with SSL configuration
wrangler pages deploy . --project-name cerebr --branch main
  1. You can also deploy to GitHub Pages:
# Fork this repository
# Then go to your repository's Settings -> Pages
# In the "Build and deployment" section:
# - Select "Deploy from a branch" as Source
# - Choose your branch (main/master) and root (/) folder
# - Click Save

The deployment will be automatically handled by GitHub Actions. You can access your site at https://<your-username>.github.io/cerebr

Web Version Features

  • ๐ŸŒ Access Cerebr from any browser without installation
  • ๐Ÿ’ป Same powerful features as the Chrome extension
  • โ˜๏ธ Deploy your own instance for better control
  • ๐Ÿ”’ Secure and private deployment

๐Ÿ“ฆ Desktop Application

After installing the dmg file, you need to execute the following command:

sudo xattr -r -d com.apple.quarantine /Applications/Cerebr.app

This project uses Pake to pack the dmg file, the command is as follows:

iconutil -c icns icon.iconset
pake https://xxx/ --name Cerebr --hide-title-bar --icon ./icon.icns

https://github.com/tw93/Pake

๐Ÿš€ Latest Updates

  • ๐Ÿ†• Added image Q&A functionality
  • ๐Ÿ”„ Optimized webpage content extraction algorithm
  • ๐Ÿ› Fixed math formula rendering issues
  • โšก Improved overall performance and stability

๐Ÿ“ Development Notes

This project is developed using Chrome Extension Manifest V3, with main tech stack:

  • ๐ŸŽจ Native JavaScript + CSS
  • ๐Ÿ“ฆ Chrome Extension API
  • ๐Ÿ”ง PDF.js + KaTeX + Marked.js

๐Ÿค Contribution Guide

Welcome to submit Issues and Pull Requests to help improve the project. Before submitting, please ensure:

  • ๐Ÿ” You have searched related issues
  • โœ… Follow existing code style
  • ๐Ÿ“ Provide clear description and reproduction steps

๐Ÿ“„ License

This project is licensed under the MIT License