BiliNote Documentation

BiliNote is an AI-powered video note assistant that generates structured Markdown notes from video links.

Key Capabilities:

• Multi-platform Support: Bilibili, YouTube, TikTok (Douyin), Kuaishou, and local video files.
• Note Customization: Selectable note formats and styles.
• Multimodal Understanding: Supports multimodal video comprehension.
• AI Q&A: RAG-based (Retrieval-Augmented Generation) AI chat about your notes, supporting Function Calling for querying original data.
• Visuals & Links: Automatic screenshot insertion and content jump links to the original video timestamp.
• History Management: Support for multiple versions of records and history playback.

On the release/X.Y.Z branch, perform the following documentation updates:

• Edit CHANGELOG.md: Add a new section ## [X.Y.Z] - YYYY-MM-DD categorized by Added, Changed, Fixed, Removed, Security, or Internal.
• Edit README.md: Update the version number in the top title and add a summary section for the new version.
• (Optional) Update CLAUDE.md for major changes.

Commit and push these changes to the origin.

git commit -am "docs: vX.Y.Z CHANGELOG + README 版本"
git push -u origin release/X.Y.Z

For users who want to avoid local deployment, dependency installation, proxy configuration, or model downloading, you can use the hosted BiliNote Pro online version. It is ready to use immediately upon registration.

URL: https://www.bilinote.app/

BiliNote supports NVIDIA GPU acceleration for local Faster Whisper transcription. The backend automatically detects CUDA if the correct environment is provided.

Requirements:

• NVIDIA GPU with drivers supporting CUDA $\ge$ 12.4.
• NVIDIA Container Toolkit installed on the host.

Setup Steps:

1. Verify GPU access on host: docker run --rm --gpus all nvidia/cuda:12.4.1-base-ubuntu22.04 nvidia-smi.
2. Stop the current CPU stack: docker-compose down.
3. Start the GPU stack: docker-compose -f docker-compose.gpu.yml up --build -d.
4. In the BiliNote UI, go to Settings $\rightarrow$ Audio Transcription Configuration and select Faster Whisper (Local).

Verification: Check logs for CUDA 可用，使用 GPU or monitor nvidia-smi during transcription.

Create two Pull Requests on GitHub to finalize the release. Both must use Merge commit (--no-ff) and follow the type(scope): subject format to pass commitlint validation.

BiliNote provides desktop clients for Windows and macOS. You can download the latest versions from the GitHub Releases page.

Important for Windows users: Ensure the application is run in an environment where the installation path does not contain Chinese characters.

https://github.com/JefferyHcool/BiliNote/releases

The release process follows a specific workflow to ensure stability and synchronization between branches.

Workflow Overview:

1. Create a release/X.Y.Z branch from develop.
2. Update CHANGELOG.md and README.md.
3. Merge release/X.Y.Z into master (using --no-ff merge commit) and back into develop (using --no-ff merge commit).
4. Tag the master branch with vX.Y.Z.
5. CI automatically builds extension artifacts and attaches them to a GitHub Release.
6. Manually upload artifacts to browser stores (Chrome, Edge, Firefox) or use automated secrets for CI-based publishing.

Once the GitHub Release is generated, manually upload the artifacts to the respective developer consoles:

• Chrome Web Store: Upload bilinote-extension-X.Y.Z.zip via the Developer Console.
• Microsoft Edge Add-ons: Upload the same .zip file via the Partner Dashboard.
• Firefox Add-ons (AMO): Upload bilinote-extension-X.Y.Z.xpi via the AMO Developer Portal.

Note: Desktop (Tauri) builds are automatically handled by GitHub Actions when a v* tag is pushed.

For production applications, it is recommended to upgrade the default ESLint configuration to use type-aware lint rules. This requires updating the extends array and configuring parserOptions to point to your tsconfig files.

export default tseslint.config({
  extends: [
    // Replace ...tseslint.configs.recommended with one of these:
    ...tseslint.configs.recommendedTypeChecked,
    // Or for stricter rules:
    ...tseslint.configs.strictTypeChecked,
    // Or for stylistic rules:
    ...tseslint.configs.stylisticTypeChecked,
  ],
  languageOptions: {
    // other options...
    parserOptions: {
      project: ['./tsconfig.node.json', './tsconfig.app.json'],
      tsconfigRootDir: import.meta.dirname,
    },
  },
})

For urgent production issues, bypass the release/* flow and use a hotfix/* branch:

1. Create a branch from master: git checkout -b hotfix/<scope>-<issue>.
2. Fix the issue.
3. Create a PR to merge into master.
4. Create a PR to merge (back-port) into develop.
5. Tag the master branch with a patch version (e.g., v2.1.1) to trigger the CI release process.

git checkout master && git pull
git checkout -b hotfix/<scope>-<事项>

To run BiliNote without Docker, follow these steps to set up the backend and frontend separately.

Prerequisites:

• Install ffmpeg and ensure it is in your system PATH.
• Python (for backend).
• pnpm (for frontend).

Steps:

1. Clone the repository and prepare the environment.
2. Start the FastAPI backend.
3. Start the Vite + React frontend.

Access the application at http://localhost:3015.

# 1. Clone and setup env
git clone https://github.com/JefferyHcool/BiliNote.git
cd BiliNote
mv .env.example .env

# 2. Start Backend (FastAPI)
cd backend
pip install -r requirements.txt
python main.py

# 3. Start Frontend (Vite + React)
cd BillNote_frontend
pnpm install
pnpm dev