1. Introduction

Yulan is an intelligent assistant application designed specifically for macOS, committed to providing users with efficient, secure, and private intelligent interaction experiences. As an intelligent assistant supporting both local and remote AI models, Yulan deeply integrates advanced artificial intelligence technology with users' actual work scenarios to help improve work efficiency and optimize information processing workflows.

Yulan's core concepts include:

• Multi-Source Search: Integrates knowledge base, custom replies, AI generation, calculator, web search, and file/application search. One input, multi-source results.
• Quick Start: The floating window can follow application windows, can be called anytime, and supports shortcut keys for quick opening/closing.
• Smart Analysis: Analyze file content based on local models, supporting PDF, images, Excel, and text formats. Data processing is local, protecting privacy.

2. System Requirements & Permissions

2.1 System Requirements

• Operating System: macOS 14.0+
• Storage Space: At least 4GB of available space recommended (for storing models and knowledge base)

2.2 Permission Requirements

Yulan requires the following permissions to function properly:

• File Access Permission: Used for knowledge base construction to access selected files and folders.
• Full Disk Access Permission (Optional): Used for file search functions to quickly find files and applications on Mac. You can configure search scope in "General Settings" > "Permissions".

3. Getting Started

3.1 Application Interface

Yulan consists of three main components:

• Status Bar Icon: Click the status bar icon to pop up a menu, including settings, show/hide floating window, exit, etc.
• Settings Window: Contains all configuration options, with a left-right column structure, navigation bar on the left
• Floating Window Interface: Smart floating window that can follow application windows, containing search box, information list, and toolbar

3.2 Initial Setup

When using Yulan for the first time, it is recommended to set up in the following steps:

1. Open the settings window (click the status bar icon → Settings, or use shortcut Cmd+,)
2. Enable necessary permissions in "General Settings"
3. Configure local models or remote API models in "Model Settings"
4. Import your documents in "Build Knowledge Base"
5. Add applications to monitor in "Follow Application Settings"

4. Core Features

4.1 Build Knowledge Base

In the settings window, click "Build Knowledge Base" in the left navigation bar to enter the knowledge base management page. Click the "+" button in the upper right or directly drag files/folders to the page to select files or folders to add.

Supported File Formats

Yulan supports the following file formats:

• PDF files: Automatically extract text content from documents
• Image files: Can recognize text in images (only used to mark sources, images do not participate in reply generation)
• Excel files (XLSX): Extract content from tables
• Plain text files: Read text content directly
• Other files: Attempt to extract text content

Build Process

1. Select files or folders to add (multi-selection supported)
2. Choose "Incremental Addition" (add on top of existing knowledge base) or "Full Override" (replace existing knowledge base)
3. Click the "Start Building" button
4. The app will automatically process file content and build indexes, with progress displayed in real-time

4.2 Custom Reply Library

In the settings window, click "Custom Replies" in the left navigation bar to enter the custom reply management page. Click the "+" button in the upper right or the "Add" button when the list is empty to input title and content, and you can add image attachments.

Using Custom Replies

Custom replies support fuzzy search. Enter keywords in the search box to quickly find. Custom replies will be displayed in the floating window search results with "Custom" identifier and copy button. Each record can be edited or deleted.

4.3 Model Settings

In the settings window, click "Model Settings" in the left navigation bar to enter the model configuration page.

Local Model Configuration

1. Click the "+" button next to "Local Model Configuration"
2. Select local model files (.gguf format) to add
3. Added models will be displayed in the list, check the models you want to use
4. You can delete unwanted models

When using local models, all data is processed on your computer, completely protecting privacy.

Remote Model Configuration

1. Click the "+" button next to "Remote Model Configuration"
2. Input platform name, API address, and API key for configuration
3. Support configuring multiple remote models, check the models you want to use

Reply Settings

In the "Reply Settings" section, you can set "My Role":

• Select built-in roles: Customer Service, Pre-sales, After-sales, PM, Engineer, Expert
• Or input custom role name

Role settings will affect the style and content of AI-generated replies.

4.4 Follow Application Settings

In the settings window, click "Follow Application Settings" in the left navigation bar to enter the application monitoring configuration page. Click the "Add" button, input application name, application identifier, and reply style. Application identifiers can be viewed in "System Information" > "Applications".

Added applications are enabled for monitoring by default, and the floating window will automatically follow the application window. You can control whether to monitor the application through the switch in the list.

In "General Settings" > "Window Settings", you can configure window display position (bottom/left/right, top not supported), whether to enable application window following, etc.

4.5 Web Search

In the settings window, click "Web Search" in the left navigation bar to enter the web search management page. Click the "+" button in the upper right, input web search name, keywords, and search URL. After configuration, you can use keywords to trigger web search in the floating window, such as entering "google search content" will jump to Google search.

The system has built-in many commonly used web searches (YouTube, Google, Baidu, Taobao, GitHub, etc.).

5. Quick Start

5.1 Floating Window Following

Yulan provides convenient floating window following functionality, allowing you to call the intelligent assistant anytime:

• Smart Following: The floating window can follow application windows, always staying in the appropriate position
• Call Anytime: Support shortcut keys for quick opening/closing of floating windows
• Seamless Integration: Does not interfere with your normal workflow

5.2 Show/Hide Methods

You can quickly start Yulan through the following methods:

• Click status bar icon → Show/Hide floating window
• Use shortcut keys for quick opening/closing
• Smart following of configured application windows

5.3 Window Settings

In "General Settings" > "Window Settings", you can configure:

• Window attachment position: bottom/left/right
• Show toolbar switch (enabled by default)
• Toolbar vertical arrangement switch (only effective when attachment position is left/right)

5.4 Follow Application Settings

Configure applications to follow in "Follow Application Settings":

• Click "Add" button to configure applications
• Input application name and identifier
• Set reply style
• Enable/disable following function

6. Multi-Source Search

The floating window will intelligently follow the application windows you are using (can be displayed at the bottom, left, or right of the window), providing magnetic effect for convenient anytime use. Enter questions in the search box, and the app will search for answers from multiple sources:

• Knowledge Base Search: Find relevant information from documents you have imported
• Custom Replies: Match your preset common reply templates
• AI Generation: Generate answers intelligently based on context and knowledge base
• Calculation: Built-in calculator for quick mathematical expression calculations
• Web Search: Jump to web searches you have configured (such as Google, Baidu, etc.)
• File/Application Search: Quickly locate files and applications on Mac

6.1 Search Result Operations

Search results will display source identifiers, support keyboard navigation (up and down arrow keys to select results), result pinning function (pinned results always display at the top), click to copy content. For search results, you can perform the following operations:

• Copy text/images to clipboard
• Open applications/files
• Show in Finder (file paths)
• Save AI replies to custom replies (only for AI-generated results)
• Delete AI replies (if saved to custom replies)
• Share files
• Pin/Unpin results (pinned results always display at the top)

6.2 Using Pin Function to Submit File Content

Through the pin button, you can automatically submit file content from search results to AI:

1. In the search result list, find the file or content you want to submit to AI
2. Click the pin button (pushpin icon) on the right side of the result row
3. Pinned content will be fixed at the top of the list and displayed as pinned status
4. When you enter a question and click the AI Generate button, pinned content will be automatically submitted as context to AI
5. AI will generate more precise answers based on pinned content
6. Click the pin button again to cancel pinning

6.3 Smart File Analysis

Yulan provides smart file analysis functionality, allowing you to quickly locate and intelligently analyze file content:

1. Enter the file to search in the search box, quickly select the target file with ↑ and ↓ keys
2. Press Enter key to lock the file
3. Enter your question in the input box
4. Generate intelligent analysis results

This function supports analysis of multiple file formats, including PDF, text files, Excel spreadsheets, etc., helping you quickly understand file content and obtain analysis results.

7. Toolbar Functions

7.1 Setting Tools

The toolbar includes the following setting buttons:

• Switch Model: Click to switch between different inference models
• Switch Role: Switch AI reply role style
• AI Generate: Click to generate AI answers
• Window Following: Enable/disable window following function
• Attachment Position: Switch window attachment position (bottom/left/right)
• Settings Window: Show/hide settings window
• Hide Toolbar: Hide toolbar (can be re-displayed through the circular button next to the search box)

7.2 System Tools

The toolbar includes system tools such as:

• Quick Screenshot: Interactive area selection, copy to clipboard, support success/failure notifications. If you insert a screenshot into the input area, the image is saved only in a local temporary directory ~/Library/Containers/run.opens.Yulan/Data/tmp/YulanPastedImages (when sandboxed; container ID may vary) for OCR and is cleared when you close the floating window or remove the thumbnail.

7.3 Application/File Icons

Matching application/file icons will be displayed in the toolbar, click to open. The number of applications displayed can be configured in "General Settings" (default 3, range 0-10).

8. Keyboard Shortcuts

Yulan provides the following keyboard shortcuts:

You can set shortcuts in the settings page for quick show/hide floating window, settings page, and preview page.

• ↑/↓: Navigate in search result list

9. Use Cases

Use Case 1: Enterprise Customer Service Personnel

1. Import product manuals and common problem documents into the knowledge base
2. Set role as "Customer Service", reply style as "Professional, Friendly"
3. Work in WeChat or enterprise chat tools, Yulan follows windows automatically
4. When receiving customer inquiries, enter keywords to obtain accurate reply suggestions based on knowledge base

Use Case 2: Content Creators

1. Organize creative materials and reference materials into the knowledge base
2. Create common reply templates in custom replies
3. Quickly obtain appropriate reply suggestions when replying to comments on social media
4. Quickly search knowledge base and web when needing to find materials

Use Case 3: Students and Researchers

1. Import course materials and research papers into the knowledge base
2. Set role as "Expert", reply style as "Rigorous, Academic"
3. Quickly find relevant knowledge during study and research
4. Use built-in calculator directly when calculations are needed

Use Case 4: Business Professionals

1. Organize business documents and contract templates into the knowledge base
2. Create business email templates in custom replies
3. Quickly obtain professional reply suggestions when working in email clients
4. Quickly locate documents on Mac when needing to find files

10. FAQ

Q: How to build a knowledge base?

A: In the settings window, click "Build Knowledge Base" in the left navigation bar to enter the knowledge base management page. Click the "+" button in the upper right or directly drag files/folders to the page to select files or folders to add. Supported file formats include: PDF files (automatically extract text content from documents), image files (can recognize text in images, only used to mark sources, images do not participate in reply generation), Excel files (XLSX, extract table content), plain text files (read text content directly), other files (attempt to extract text content). After selection, you can choose "Incremental Addition" (add on top of existing knowledge base) or "Full Override" (replace existing knowledge base), then click the "Start Building" button. The app will automatically process file content and build indexes, with progress displayed in real-time.

Q: What file formats does the knowledge base support?

A: Yulan supports the following file formats: PDF files (automatically extract text content from documents), image files (can recognize text in images, only used to mark sources, images do not participate in reply generation), Excel files (XLSX, extract table content), plain text files (read text content directly), other files (attempt to extract text content). The app will automatically scan all supported format files in the folder. It is recommended to use files of appropriate size, as overly large files may affect processing speed.

Q: How to add and manage custom replies?

A: In the settings window, click "Custom Replies" in the left navigation bar to enter the custom reply management page. Click the "+" button in the upper right or the "Add" button when the list is empty to input title and content, and you can add image attachments. Custom replies support fuzzy search. Enter keywords in the search box to quickly find. Custom replies will be displayed in the floating window search results with "Custom" identifier and copy button. Each record can be edited or deleted.

Q: How to configure local and remote models?

A: In the settings window, click "Model Settings" in the left navigation bar to enter the model configuration page. Local models: Click the "+" button next to "Local Model Configuration", select local model files to add. Added models will be displayed in the list, check the models you want to use. You can delete unwanted models. When using local models, all data is processed on your computer, completely protecting privacy. Remote models: Click the "+" button next to "Remote Model Configuration", input platform name, API address, and API key for configuration. Support configuring multiple remote models, check the models you want to use. Note: When using remote models, query content will be sent to remote servers. If you value the privacy of your data and content, it is recommended to use local models.

Q: How to use the floating window? What search functions are supported?

A: The floating window will intelligently follow the application windows you are using (can be displayed at the bottom, left, or right of the window), providing magnetic effect for convenient anytime use. Enter questions in the search box, and the app will search for answers from multiple sources: knowledge base search, custom replies, AI generation, calculation, web search, file/application search. Search results will display source identifiers, support keyboard navigation (up and down arrow keys to select results), result pinning function (pinned results always display at the top), click to copy content. You can configure the display position of the floating window, whether to display the toolbar, etc. in "General Settings".

Q: How to set up monitoring applications and window following?

A: In the settings window, click "Follow Application Settings" in the left navigation bar to enter the application monitoring configuration page. Click the "Add" button, input application name, application identifier, and reply style. Application identifiers can be viewed in "System Information" > "Applications". Added applications are enabled for monitoring by default, and the floating window will automatically follow the application window. You can control whether to monitor the application through the switch in the list. In "General Settings" > "Window Settings", you can configure window display position (bottom/left/right, top not supported), whether to enable application window following, etc.

Q: How to configure web search?

A: In the settings window, click "Web Search" in the left navigation bar to enter the web search management page. Click the "+" button in the upper right, input web search name, keywords, and search URL. After configuration, you can use keywords to trigger web search in the floating window, such as entering "google search content" will jump to Google search.

Q: What permissions are needed? How to enable them?

A: Yulan requires the following permissions to function properly: file access permission (used for knowledge base construction to access selected files and folders), full disk access permission (optional, used for file search functions to quickly find files and applications on Mac. You can configure search scope in "General Settings" > "Permissions"). The app will guide you to enable necessary permissions on first launch. Please follow the prompts to operate.

Q: Where is data stored? How is privacy and security guaranteed?

A: All data is stored on your Mac device, and the app runs completely locally. Knowledge base data, custom replies, model files, etc. are all stored locally. All data will not be uploaded to any server. If using remote model APIs, query content will be sent to remote servers for processing. If you do not want to upload file content, do not pin files. Your knowledge base data, custom replies, and all other local data will not be uploaded, completely protecting your privacy and security.

11. Privacy & Security

Yulan strictly follows privacy protection principles:

• Local Processing: All data processing is completed on your device
• No Data Upload: No data will be sent to any server unless you actively configure remote APIs
• When you use "Quick Screenshot" and insert the screenshot into the input area, the image is saved in a local temporary directory ~/Library/Containers/run.opens.Yulan/Data/tmp/YulanPastedImages for OCR and is cleared when you close the floating window or remove the thumbnail
• Transparent Permissions: All permission requests have clear explanations; you can manage them in system settings at any time (the current version does not request Accessibility permission)
• Data Controllability: You can delete all data such as knowledge base and custom replies at any time

12. Contact Us

If you have any questions, suggestions, or feedback, please contact us through the following methods: