Linkly AI CLI
The Linkly AI client: an agent searches local documents, reads and saves notes, with an MCP bridge for Claude Desktop
- 43 ★ on the repository
- Last commit
- Apache-2.0
Extended access
Why this level
- The agent reads indexed documents and writes notes to the desktop machine through `note-save`
- `--remote` calls the cloud gateway with an API key stored in `~/.linkly/credentials.json`
Install
- Works in
Manual install
curl -sSL https://updater.linkly.ai/cli/install.sh | shThe macOS and Linux script. For Windows the README has a PowerShell variant.
Access and checks
How we reviewExtended accessThe tool runs code or makes network calls and only reads external data.
- The agent reads indexed documents and writes notes to the desktop machine through `note-save`
- `--remote` calls the cloud gateway with an API key stored in `~/.linkly/credentials.json`
This is third-party code. Review the repository files before installing.
What it does
The `linkly` command talks to the Linkly AI desktop app and searches its document index: PDF, Markdown, DOCX, PPTX, EPUB, TXT and HTML. The app must be running with its MCP server enabled. The CLI finds the port from `~/.linkly/port` on its own. The `search`, `find-paths`, `outline`, `grep`, `read` and `list` commands cover the whole path from search to reading: filters by type, library, path pattern and modification date, time sorting and line-range reads. `note-save` creates and edits Markdown notes with a version check on edits. `--json` prints one object per result and `--exit-code` returns 0, 1 or 2. `linkly mcp` starts an MCP bridge over stdio for Claude Desktop, Cursor and other clients. Besides the local app, the client connects to a device on the local network (`--lan`) or to the cloud gateway through a tunnel (`--remote`). The `linkly skills` subcommands install and update the `linkly-ai` skill, which teaches an agent to use these commands.
Who it is for. People who keep work material in PDF, Markdown and Office files and want an agent to search it from the terminal.
Good fit when
- You need to find a document by meaning in a folder of reports and notes, not by file name
- An agent should pull only a section by heading, or only matching lines, from a long PDF
- Notes from a chat with an agent are saved as Markdown on the desktop machine
- Claude Desktop or Cursor is connected to a local document base through a ready MCP bridge
- Documents sit on another device on the same network and are searched with a LAN token
Not a fit when
- The Linkly AI desktop app is absent: the CLI does not index documents itself and works as a client
- You need to search repository code: `grep` and the agent's own tools fit that better
- Installing through `curl ... | sh` is forbidden in your environment: take the Homebrew package, Cargo or a release archive
Example request
Find the 2024 quarterly report in my documents, show its outline and read the section on expenses.Limitations
Without the Linkly AI app running with its MCP server enabled, the CLI connects only to a LAN device or the cloud. `--remote` needs a sign-in through `linkly auth login` or an API key.
Notes live on the desktop machine, and there is no cloud notes store. `note-save` needs app version 0.11.0 or newer.
On older app versions, editing a note with `--tags` replaces the whole tag set.
Links to documentation and community channels lead to linkly.ai.
How to disable. Remove the bridge from the client config and the CLI with `brew uninstall linkly` or `cargo uninstall linkly-ai-cli`, depending on how you installed it. `linkly auth logout` deletes saved keys.
FAQ
Do I need the Linkly AI desktop app?
Yes, in the default mode. The CLI finds the app through the `~/.linkly/port` file. The `--lan` and `--remote` modes connect a device on the network or the cloud gateway.
How do I connect Linkly to Claude Desktop?
Add a server to `claude_desktop_config.json` with the command `linkly` and the argument `mcp`. For the cloud, append `--remote` to the arguments.
What does the linkly-ai skill add?
It teaches the agent how to use the CLI commands. `linkly skills status` shows its state, `linkly skills install` installs it and `linkly skills update` upgrades it.
Which document formats does search cover?
PDF, Markdown, DOCX, PPTX, EPUB, TXT and HTML. Pass the type list to `--type`, for example `--type pdf,md`.
What is the --client flag for?
It labels a call with the agent's name in the desktop app's access log. It is a label and grants nothing. Agents are advised to pass it every time.
Discussion
No questions or reviews yet.
Related
CLI toolsAn agent searches, reads and writes a Roam Research graph through the desktop app's local API, with a CLI and a syntax skill
Get笔记 CLI (getnote)
Get笔记 CLI
The getnote CLI saves links and text to Get笔记 (Dedao Brain), searches notes and knowledge bases and installs five agent skills.
Notes, tasks, contacts and project context live in Markdown on your disk, and Claude Code and Codex read the same memory
A skill and MCP server for Claude Code that drives Google NotebookLM: notebooks from links and files, cited answers, podcasts, slides and quizzes
An MCP server that lets an agent work on your computer: terminal and long-running processes, file search and edits, Excel, PDF and DOCX
mcp-logseq: MCP server for Logseq
MCP server for LogSeq
MCP server for Logseq: the agent reads, searches and edits pages and blocks of your graph over the local HTTP API
README in short
The docs list install routes (script, Homebrew, Cargo, release archives, build from source), commands with options and three connection modes: local, LAN and remote. Separate sections explain browser sign-in, agent-friendly login without waiting (`--no-wait`) and the `linkly doctor` diagnostics.