Linkly AI
Sign in
0Link

LinklyAI Help Doc

Public

blueeon/linkly-ai-help-doc

0372Design & Product@blueeon2026-08-146 days ago

About

LinklyAI Help Doc is the official help documentation knowledge base for the Linkly AI product, designed to provide users with a complete product usage guide, tool reference, and integration solutions.

product demo

Background Information

This knowledge base is maintained by Linkly AI and is a public product knowledge base primarily aimed at users who use Linkly AI for local document management, AI search, and intelligent assistants. The content covers the entire process from basic installation to advanced features, helping users get started quickly and fully leverage Linkly AI's capabilities.

Main Content

The knowledge base revolves around Linkly AI's core functionalities and mainly includes the following topics:

  • Agent Setup and Integration: Provides installation, integration, and verification guides for AI agents, helping users connect Linkly AI with various AI assistants.
  • Desktop Application and Chatbot: Introduces how to use the chat feature in the desktop application, allowing AI to search local documents and provide answers with citations.
  • Search and Query Strategies: Explains the principles of BM25 + hybrid vector search in depth, as well as how to use advanced search syntax (e.g., shortcut keys ⌘ ⇧, ⌘ ctrl) to improve query efficiency.
  • MCP Tools and Command Line Interface: Details the nine tools exposed by Linkly AI's MCP server (including list_libraries, explore, search, etc.), as well as the CLI's remote search and local file retrieval capabilities.
  • Product Updates and Basics: Records version release information and feature updates through changelogs, while providing practical tips in the form of "💡 tips".

Documents within the knowledge base are organized by topic in folders such as references, use-cases, and integration for convenient reference.

Representative Materials

  • changelog: Product update log, showcasing key version information such as the release of cloud embedding in v0.12.0.
  • mcp-tools-reference: MCP tool reference document, listing all read-only tools and their purposes.
  • tools-intro: Introduction to MCP tools, explaining how these tools provide document search, browsing, and note-taking capabilities for AI assistants.
  • SKILL: Describes Linkly AI's capabilities as an AI skill: searching, browsing, reading, and taking notes in user documents.
  • agent-setup: Agent setup guide, instructing users on how to let AI agents automatically complete the installation, integration, and verification process.
  • cli-reference: CLI reference document, explaining how to search local documents and associated cloud libraries from the terminal.

Target Audience

  • Users of Linkly AI desktop application and CLI who want to quickly master product features.
  • Developers and advanced users who wish to integrate Linkly AI into AI assistants or workflows.
  • Technical personnel who need a systematic understanding of Linkly AI's search strategies, MCP tools, and agent configuration.

Files

72 documents in total (showing first 50)

  • MD

    12-real-tasks-on-10000-local-docs

    12-real-tasks-on-10000-local-docs.mdx

    13.2 KB2.2k chars
  • MD

    Introducing-linkly-ai

    Introducing-linkly-ai.mdx

    11.8 KB2.0k chars
  • MD

    README

    README.md

    7.4 KB933 chars
  • MD

    README

    README.md

    14.1 KB1.5k chars
  • MD

    SKILL

    SKILL.md

    32.4 KB4.7k chars
  • MD

    agent-setup

    agent-setup.mdx

    26.3 KB3.8k chars
  • MD

    ai-search-docs-without-leaving-terminal

    ai-search-docs-without-leaving-terminal.mdx

    3.9 KB597 chars
  • MD

    before-after-local-docs-transform-claude

    before-after-local-docs-transform-claude.mdx

    10.2 KB1.6k chars
  • MD

    changelog

    changelog.mdx

    47.5 KB7.3k chars
  • MD

    cli-best-interface-for-ai-agents

    cli-best-interface-for-ai-agents.mdx

    10.1 KB1.6k chars
  • MD

    community

    community.mdx

    941 B142 chars
  • MD

    faq

    faq.mdx

    19.3 KB2.9k chars
  • MD

    indexing

    indexing.mdx

    16.3 KB2.3k chars
  • MD

    integration

    integration.mdx

    8.0 KB1.2k chars
  • MD

    use-in-chatgpt

    integration/use-in-chatgpt.mdx

    4.2 KB619 chars
  • MD

    use-in-cherry-studio

    integration/use-in-cherry-studio.mdx

    3.0 KB430 chars
  • MD

    use-in-claude-code

    integration/use-in-claude-code.mdx

    3.1 KB453 chars
  • MD

    use-in-claude

    integration/use-in-claude.mdx

    3.0 KB439 chars
  • MD

    use-in-codex

    integration/use-in-codex.mdx

    2.2 KB334 chars
  • MD

    use-in-cowork

    integration/use-in-cowork.mdx

    5.1 KB689 chars
  • MD

    use-in-cursor

    integration/use-in-cursor.mdx

    3.2 KB437 chars
  • MD

    use-in-dify

    integration/use-in-dify.mdx

    3.4 KB532 chars
  • MD

    use-in-gemini-cli

    integration/use-in-gemini-cli.mdx

    2.6 KB323 chars
  • MD

    use-in-github-copilot

    integration/use-in-github-copilot.mdx

    2.6 KB369 chars
  • MD

    use-in-kimi-code

    integration/use-in-kimi-code.mdx

    5.0 KB762 chars
  • MD

    use-in-lm-studio

    integration/use-in-lm-studio.mdx

    2.3 KB354 chars
  • MD

    use-in-n8n

    integration/use-in-n8n.mdx

    3.2 KB473 chars
  • MD

    use-in-openclaw

    integration/use-in-openclaw.mdx

    3.2 KB467 chars
  • MD

    use-in-qoderwork

    integration/use-in-qoderwork.mdx

    4.8 KB651 chars
  • MD

    use-in-qwenpaw

    integration/use-in-qwenpaw.mdx

    4.3 KB545 chars
  • MD

    use-in-raycast

    integration/use-in-raycast.mdx

    2.2 KB338 chars
  • MD

    use-in-windsurf

    integration/use-in-windsurf.mdx

    2.9 KB345 chars
  • MD

    use-in-workbuddy

    integration/use-in-workbuddy.mdx

    5.6 KB722 chars
  • MD

    use-in-zcode

    integration/use-in-zcode.mdx

    5.8 KB827 chars
  • MD

    introduction

    introduction.mdx

    6.4 KB929 chars
  • MD

    library-setup

    library-setup.mdx

    20.5 KB3.0k chars
  • MD

    linkly-account

    linkly-account.mdx

    19.7 KB2.8k chars
  • MD

    linkly-space

    linkly-space.mdx

    18.6 KB2.8k chars
  • MD

    model-service

    model-service.mdx

    16.2 KB2.5k chars
  • MD

    one-command-ai-tools-read-local-files

    one-command-ai-tools-read-local-files.mdx

    3.8 KB612 chars
  • MD

    outlines-index-progressive-disclosure-for-ai-agents

    outlines-index-progressive-disclosure-for-ai-agents.mdx

    15.7 KB2.4k chars
  • MD

    pkm-evolution-ai-second-brain

    pkm-evolution-ai-second-brain.mdx

    12.8 KB2.1k chars
  • MD

    privacy-first-local-ai-knowledge-base

    privacy-first-local-ai-knowledge-base.mdx

    8.9 KB1.5k chars
  • MD

    quickstart

    quickstart.mdx

    9.0 KB1.4k chars
  • MD

    cli-reference

    references/cli-reference.md

    35.4 KB3.7k chars
  • MD

    mcp-tools-reference

    references/mcp-tools-reference.md

    72.0 KB5.6k chars
  • MD

    search-strategies

    references/search-strategies.md

    20.6 KB3.0k chars
  • MD

    troubleshooting

    references/troubleshooting.md

    21.8 KB3.1k chars
  • MD

    release-plan

    release-plan.mdx

    5.7 KB820 chars
  • MD

    researcher-ai-workflow-managing-1000-papers

    researcher-ai-workflow-managing-1000-papers.mdx

    10.8 KB1.7k chars