Использование Linkly AI CLI

Что такое Linkly AI CLI

linkly подключается к Desktop или облачному MCP и предоставляет инструменты в оболочке. Он особенно удобен ИИ-агентам, конвейерам и клиентам со stdio. CLI не создаёт отдельный индекс: в локальном режиме Desktop должен быть запущен.

Установка

macOS / Linux
Windows
Cargo

Выполните в терминале:

curl -sSL https://updater.linkly.ai/cli/install.sh | sh

Либо установите через Homebrew:

brew tap LinklyAI/tap
brew install linkly

Выполните в PowerShell:

irm https://updater.linkly.ai/cli/install.ps1 | iex

Установите пакет с crates.io; требуется Rust toolchain:

cargo install linkly-ai-cli

Если Linkly AI Desktop уже установлен, CLI можно поставить из него: на экране Connect an agent мастера первого запуска нажмите Install — будут установлены CLI и Skills; либо на странице Agent usage главного окна в разделе Advanced нажмите Install в строке Linkly AI CLI. Если появится окно One last step, нажмите Set up, чтобы команда linkly запускалась прямо из терминала.

После установки откройте новый shell и проверьте:

linkly --version

По умолчанию CLI находит локальный Desktop через ~/.linkly/port. Для другого устройства в LAN или облачного туннеля используйте режимы подключения ниже.

Основные команды

CLI следует процессу search → grep или outline → read. Если пользователь называет контейнер, но реальный путь неизвестен, сначала вызовите find-paths.

Успешный вывод заканчивается UTC-строкой [meta] now=2026-05-08T...Z, а JSON содержит _meta.now. Она нужна ИИ для расчёта относительных дат. Пользователь может её игнорировать; скрипт при необходимости должен удалить последнюю строку.

Состояние

linkly status
linkly status --json
linkly doctor

status возвращает состояние и версию Desktop, число проиндексированных документов и ход индексирования.

Поиск

linkly search "keywords or phrases"
linkly search "API design" --limit 5
linkly search "meeting minutes" --type pdf,docx
linkly search "budget report" --json
linkly search "quarterly report" --modified-after 2024-07-01 --modified-before 2024-09-30
linkly search "weekly retro" --time-sort newest --limit 5
linkly search "we decided to postpone" --type audio,video
linkly search "onboarding checklist" --scope notes

--modified-after и --modified-before принимают UTC ISO 8601: дату либо полный RFC 3339. --time-sort принимает newest и oldest; без него сохраняется порядок BM25 + векторной релевантности.

--scope notes ограничивает поиск заметками и игнорирует --library и --path-glob.

Структура документа

linkly outline <DOC_ID>
linkly outline id1 id2 id3
linkly search "architecture" --json | jq -r '.results[].doc_id' | linkly outline -

Длинная структура частично сворачивается. Через --expand укажите ID узлов для раскрытия через запятую, остальные будут свёрнуты; без параметра выбор делается автоматически:

linkly outline <DOC_ID> --expand 2,3.1

Outline лучше всего работает с Markdown, DOCX, DOC, PPTX, XLSX, CSV, EPUB и RTF. Для простого текста и PDF без закладок используйте read.

Поиск шаблона внутри документов

linkly grep <PATTERN> <DOC_ID>...
linkly grep "useState" 456
linkly grep "error|warning" 1044 -C 3 -i
linkly grep "TODO" 591 --mode count
linkly grep "import" 302 --offset 20 --limit 20
linkly search "deployment" --json | jq -r '.results[].doc_id' \
  | linkly grep "docker|kubernetes" -

Чтение

linkly read <DOC_ID>...
linkly read <DOC_ID> --offset 50 --limit 100
linkly read <DOC_ID> --image-text full
linkly read id1 id2 id3
linkly search "onboarding" --json | jq -r '.results[].doc_id' | linkly read -

При нескольких документах --json печатает JSON Lines — один объект на строку. Для одного ID остаётся один JSON-объект.

Длинный документ читайте страницами:

linkly read <DOC_ID> --offset 1 --limit 200
linkly read <DOC_ID> --offset 201 --limit 200
linkly read <DOC_ID> --offset 401 --limit 200

Поиск путей

find-paths агрегирует каталоги, соответствующие вариантам имени, чтобы затем использовать --path-glob:

linkly find-paths --patterns Notion,notion --limit 5
linkly search "shopping receipt" --path-glob "*Notion-Export*"
linkly find-paths --patterns Slack,slack --library work-notes

Передавайте несколько вариантов одним вызовом: они объединяются OR. Если шаблон совпал только с именем файла, а не сегментом каталога, результат отбрасывается; при нулевом ответе попробуйте search без --path-glob. Если имя каталога содержит *, ? или [, копируйте уже экранированное поле path_glob из ответа.

Библиотеки и обзор (list-libraries, explore)

linkly list-libraries

Перечисляет доступные библиотеки. Имена из ответа можно передавать в --library других команд.

linkly explore
linkly explore --library work-notes

Даёт общий обзор всех документов или одной библиотеки — удобно перед поиском, чтобы понять, какие материалы есть. --library принимает имя или local://<id>; с --remote также cloud://<owner>/<slug>.

Notes

linkly list --scope notes
linkly list --scope notes --tags project,urgent
linkly note-save --mode create --content "Не забыть обновить сертификат" --tags ops
some-command | linkly note-save --mode create --content -

Заметки — обычные локальные Markdown-файлы в папке библиотеки; они не загружаются в облако и индексируются как остальные документы. note-save — команда записи, поэтому ИИ вызывает её только по явному запросу пользователя. Для редактирования сначала получите note_id и текущую version через list, прочитайте полное тело, затем передайте оба значения и полный новый текст:

linkly note-save --mode edit \
  --note-id <uuid> --base-version <version> \
  --tags ops --content "Обновлённый текст"

Встроенные #tags в теле являются тегами заметки. --tags только добавляет: для удаления уберите маркер из полного содержимого. Desktop старше 0.11.0 требует --tags при редактировании и заменяет весь набор. --base-version защищает от конкурентного изменения: команда вернёт NOTE_VERSION_CONFLICT, а не перезапишет чужую правку. Разрешены абзацы, жирный и зачёркнутый текст и списки; заголовки, код, ссылки и таблицы отклоняются.

Диагностика подключения (doctor)

linkly doctor

Проверяет подключение к локальному Desktop, а также сохранённые удалённый ключ и LAN-подключение, если они есть. Для каждого подключения выводится отдельная группа результатов с советами при ошибке. Код завершения 0, если доступно хотя бы одно подключение. С --remote, --lan или --endpoint / --token проверяется только это подключение, и код завершения зависит только от него:

linkly doctor --remote

Управление Skills (skills)

linkly skills status    # установленная версия, последняя опубликованная и путь установки
linkly skills install   # скачать и установить Skills
linkly skills update    # обновить установленные Skills, а если их нет — установить

install ставит Skills в ~/.agents/skills/linkly-ai и создаёт ссылку на них в ~/.claude/skills/linkly-ai. Подробнее: Linkly AI Skills. Когда выходит новая версия Skills, в конце вывода команд появляется строка-подсказка, не чаще раза в 4 часа. Переменная окружения LINKLY_NO_SKILLS_HINT=1 отключает её; если задать её в конфигурации MCP-клиента, подсказки не будет и в мосте linkly mcp.

Автодополнение

linkly completions <SHELL>

Печатает статический скрипт для bash, zsh, fish, powershell или elvish.

zsh
bash
fish
PowerShell

mkdir -p ~/.zfunc
linkly completions zsh > ~/.zfunc/_linkly
# Добавьте в ~/.zshrc:
#   fpath=(~/.zfunc $fpath)
#   autoload -Uz compinit && compinit

linkly completions bash > /usr/local/etc/bash_completion.d/linkly

linkly completions fish > ~/.config/fish/completions/linkly.fish

linkly completions powershell | Out-String | Invoke-Expression

После этого откройте новый shell. Скрипт не обращается к Desktop и не замедляет приглашение.

Режим MCP

linkly mcp

Команда запускает stdio MCP-сервер для совместимых ИИ-клиентов. Направление определяет доступный контент:

Команда	Куда подключается
`linkly mcp`	Локальный Desktop и только локальный контент
`linkly mcp --remote`	Облачный шлюз, локальный контент и подключённые облачные библиотеки

Только --remote даёт мосту доступ к облачным библиотекам. Сначала войдите через linkly auth login (см. Удалённый).

Мост не подключается к Desktop на другом устройстве в LAN. ИИ-клиенты в LAN подключайте к Desktop напрямую по HTTP (см. Доступ по LAN); клиентам только со stdio подойдёт linkly mcp --remote.

--client <имя> задаёт имя приложения в журнале доступа Desktop, как в примерах ниже. С --remote имя также передаётся облачному шлюзу. Для Claude Desktop добавьте в ~/Library/Application Support/Claude/claude_desktop_config.json на macOS или %APPDATA%\Claude\claude_desktop_config.json на Windows:

{
  "mcpServers": {
    "linkly-ai": {
      "command": "linkly",
      "args": ["mcp", "--client", "claude-desktop"]
    }
  }
}

В Cursor откройте Settings → MCP Servers → Add Server и задайте имя linkly-ai, команду linkly mcp --client cursor.

Обновление

linkly self-update

Команда проверяет и устанавливает последнюю версию. CLI также проверяет обновления в фоне при запуске и подсказывает выполнить её.

Режимы подключения

Режим	Флаги	Как работает
Локальный	Без флагов	Автоматически читает порт Desktop из `~/.linkly/port`
LAN	`--lan`	Напрямую подключается к другому устройству в локальной сети по сохранённым адресу и токену
Удалённый	`--remote`	Использует облачный туннель `https://mcp.linkly.ai` и API key

Без --lan или --remote CLI подключается только к Desktop на этом компьютере.

API Key (начинается с lkai_) и токен LAN-доступа — это ключи к вашей локальной библиотеке. Не вставляйте их ни в какой диалог с ИИ (ChatGPT, Claude, Cursor, Codex, Doubao, Kimi и т. п.) и не позволяйте ИИ-помощнику выполнять за вас linkly auth set-key: содержимое диалога отправляется поставщику модели и сохраняется в истории чата, а в некоторых приложениях ещё и синхронизируется в облако. Чтобы ИИ-помощник подключился удалённо, используйте двухшаговый linkly auth login ниже — вы только подтверждаете доступ в браузере. set-key выполняйте сами, в своём терминале. Если ключ уже попал в диалог, отзовите его и создайте новый в Dashboard; LAN-токен перегенерируется в View MCP connection settings.

Локальный

linkly search "machine learning"
linkly status

Используется локальный Desktop и фактический порт из настроек.

LAN

Адрес и токен берутся на том устройстве: в его Desktop откройте страницу Agent usage, в разделе Management включите Allow LAN access, затем в разделе Integration нажмите View MCP connection settings и скопируйте данные из раздела LAN (подробнее: Доступ по LAN). Затем один раз сохраните их на этом компьютере — сами, в своём терминале:

linkly auth set-key your_lan_token --lan --endpoint http://192.168.1.100:60606

Затем добавляйте --lan к любой команде:

linkly search "report" --lan
linkly status --lan

Без сохранения можно передавать адрес и токен напрямую:

linkly search "report" --endpoint http://192.168.1.100:60606/mcp --token your_lan_token

После перегенерации токена повторите auth set-key --lan с новым токеном. Удалить сохранённую LAN-конфигурацию: linkly auth logout --lan.

Сохранение LAN-подключения и флаг --lan требуют CLI 1.0.0 или новее. CLI хранит только одно LAN-подключение: повторный auth set-key --lan перезаписывает сохранённые адрес и токен. Для временного подключения к другому устройству используйте --endpoint и --token.

Удалённый

Сначала один раз войдите в аккаунт:

linkly auth login

CLI выводит одноразовую ссылку и код подтверждения (XXXX-XXXX) и, если может, сам открывает браузер. Откройте ссылку на любом устройстве (если CLI работает на сервере, подойдёт и телефон), войдите, сверьте код с тем, что показан в терминале, и нажмите Авторизовать — CLI сохранит только что выпущенный API key. Ссылка действует 10 минут; на странице видны авторизуемый аккаунт, код подтверждения, запрашивающее устройство (с его собственных слов) и выдаваемые права. Чтобы CLI не пытался открыть браузер, добавьте --no-browser — тогда он только напечатает ссылку. Затем добавляйте --remote к любой команде:

linkly search "machine learning" --remote
linkly status --remote

Агенты и скрипты, которые не могут ждать на переднем плане, делят вход на два шага. Агент передаёт вам только ссылку и код; ключ CLI сохраняет сам, поэтому он не проходит через диалог. Оба шага выполняйте в одном окружении, от одного системного пользователя и с одним каталогом конфигурации:

linkly auth login --no-wait --json   # {"status":"pending","url":…,"user_code":…,"expires_in":600}
# … передайте url и user_code пользователю и дождитесь авторизации …
linkly auth login --wait --json      # {"status":"ok","account":…,"plan":…,"key_preview":…}

--wait сдаётся через 300 секунд (меняется через --timeout) с кодом timeout; пока ссылка действует, запустите его снова. В режиме --json ошибки содержат code: timeout, expired, denied, no_pending_login, login_in_progress (используйте --wait или начните заново с --restart), already_logged_in (сначала linkly auth logout) и network. Каждое сообщение называет следующую команду. Каждый вход создаёт новый API key с именем cli-<hostname>-xxxx; его видно в Dashboard, там же его можно отозвать. У аккаунта может быть не больше 10 API key; при достижении лимита страница авторизации сообщит об этом. Успешный вход подтверждает только аккаунт — он не означает, что облачные библиотеки или Desktop доступны. Удобнее вставить ключ? Создайте его в Dashboard и сохраните его сами, в своём терминале:

linkly auth set-key lkai_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Проверить или удалить сохранённый ключ:

linkly auth status   # какой ключ используется, действителен ли он, ваш тариф и сохранённая LAN-конфигурация
linkly auth logout   # удалить сохранённый API key (LAN-конфигурация остаётся); ключ от auth login также отзывается

logout отзывает ключ, выпущенный auth login, — он перестаёт работать примерно через 90 секунд. Ключ, сохранённый через set-key, только удаляется с этого компьютера, ведь он может использоваться где-то ещё; при необходимости отзовите его в Dashboard. Учётные данные (и вход, ожидающий подтверждения) по умолчанию хранятся в ~/.linkly. Переменная LINKLY_CONFIG_DIR переносит их в другое место — например, по каталогу на каждого пользователя, если агент обслуживает нескольких людей из-под одной системной учётной записи. В каждом каталоге — один аккаунт. Обнаружение локального Desktop (~/.linkly/port) это не затрагивает.

LINKLY_CONFIG_DIR=~/.linkly-alice linkly auth login --no-wait --json
LINKLY_CONFIG_DIR=~/.linkly-alice linkly search "notes" --remote

Для облачной библиотеки добавьте --library cloud://username/slug.

--lan, --remote и --endpoint несовместимы друг с другом. --endpoint и --token обязательны вместе; сохранённая LAN-конфигурация в этом случае не используется.

Справочник параметров

Глобальные параметры

Параметр	Область	Назначение
`--lan`	LAN	Адрес и токен, сохранённые через `auth set-key --lan`; несовместим с `--remote` и `--endpoint`
`--endpoint <URL>`	LAN	Конкретный MCP endpoint; требует `--token`
`--token <TOKEN>`	LAN	Bearer-токен, обязателен с `--endpoint` и несовместим с `--remote`
`--remote`	Remote	Облачный туннель `https://mcp.linkly.ai`, несовместим с `--endpoint`
`--json`	Большинство команд	Машиночитаемый JSON; некоторые команды его не поддерживают, см. подсказку ниже
`--exit-code`	Все команды	Отличать «ничего не найдено» (1) от ошибки (2)
`--client <имя>`	Все команды	Имя вызывающего приложения, напр. `--client claude-code`. Агентам следует указывать его всегда
`-V, --version`	—	Версия CLI
`-h, --help`	—	Справка

--lan, --endpoint, --token, --remote работают у документных команд, status и doctor. mcp принимает только --remote. --json не действует для auth set-key, self-update, skills install, skills update, completions и mcp.

Коды завершения

Без флага используются обычные значения: 0 — успех, 1 — ошибка; пустой результат считается успехом. Ошибки аргументов (нет обязательного параметра, недопустимое значение и т. п.) всегда дают 2, с --exit-code или без него. С --exit-code:

Код	Значение
`0`	Команда выполнена и вернула хотя бы один результат
`1`	Команда выполнена, но ничего не найдено (только `search`, `find-paths`, `grep`, `list`)
`2`	Ошибка подключения, авторизации, аргументов или выполнения

linkly search "quarterly report" --exit-code && open-report

Флаг необязателен, потому что меняет смысл кода 1; существующие сценарии без него продолжают трактовать 1 как ошибку.

Параметры search

Параметр	Описание	По умолчанию
`<QUERY>`	Обязательные ключевые слова или фраза	—
`--limit <N>`	Число результатов, 1–50	20
`--type <TYPES>`	Список через запятую: `pdf`, `docx`, `doc`, `pptx`, `xlsx`, `csv`, `epub`, `rtf`, `md`, `txt`, `html`, `image`, `audio`, `video`	Все
`--library <NAME>`	Ограничение одной библиотекой	—
`--path-glob <PATTERN>`	Подстрочный фильтр пути; если путь неизвестен, сначала `find-paths`	—
`--modified-after <ISO>`	Включительная нижняя временная граница	—
`--modified-before <ISO>`	Включительная верхняя временная граница	—
`--time-sort <MODE>`	`newest` или `oldest`; без него порядок по релевантности	—
`--scope <SCOPE>`	`folder` либо `notes`; заметки игнорируют library/path	folder
`--tags <LIST>`	AND-фильтр тегов заметок	—

Параметры find-paths

Параметр	Описание	По умолчанию
`--patterns <LIST>`	Обязательные варианты через запятую, объединённые OR	—
`--library <NAME>`	Конкретная библиотека	—
`--limit <N>`	Число каталогов, 1–50	10

Параметры outline

Параметр	Описание
`<ID>...`	Один или несколько обязательных ID; `-` читает по одному ID на строку из stdin
`--expand <IDS>`	ID узлов структуры для раскрытия через запятую (например, `2,3.1`), остальные сворачиваются; по умолчанию выбор автоматический

Параметры grep

Параметр	Описание	По умолчанию
`<PATTERN>`	Обязательное регулярное выражение	—
`<DOC_ID>...`	Один или несколько ID; `-` читает stdin	—
`-C, --context`	Строки до и после	3
`-B, --before` / `-A, --after`	Отдельный контекст до/после	—
`-i`	Без учёта регистра	—
`--mode`	`content` или `count`	content
`--limit` / `--offset`	Максимум совпадений (до 100) / пропуск для пагинации	20 / 0
`--fuzzy-whitespace`	`true`, `false` или авто (PDF включено, остальные выключены)	auto

Параметры read

Параметр	Описание	По умолчанию
`<ID>...`	Один или несколько ID; `-` читает stdin	—
`--offset <N>`	Первая строка	1
`--limit <N>`	Число строк, максимум 500	200
`--image-text <DETAIL>`	`none`, `abstract` или `full`	abstract

Параметры list

Параметр	Описание	По умолчанию
`--scope <SCOPE>`	Обязательный контейнер `folder`, `library` или `notes`	—
`--library <LIB>`	Имя, `local://<id>` или облачный `cloud://<owner>/<slug>`	—
`--path <DIR>`	Абсолютный локальный каталог или относительный облачный префикс	—
`--type <LIST>`	Типы через запятую только для folder/library	Все
`--modified-after` / `--modified-before`	Временные границы только для folder/library	—
`--tags <LIST>`	AND-теги только для notes	—
`--limit <N>` / `--offset <N>`	Размер страницы (до 200, со сниппетами 50) / смещение	50 / 0
`--sort <ORDER>`	`recent`, `oldest` или `name`	recent
`--snippet` / `--no-snippet`	Принудительно включить/выключить сниппеты	По области

Параметры note-save

Параметр	Описание
`--mode <MODE>`	`create` либо `edit`; для edit нужны ID и version
`--content <TEXT>`	Обязательное полное тело; `-` читает stdin
`--note-id <UUID>`	ID редактируемой заметки из `list`
`--base-version <HASH>`	Текущая версия; предотвращает перезапись конкурентных правок
`--tags <LIST>`	Теги только для добавления; удаляйте `#tag` из тела
`--app-name <NAME>`	Имя приложения-источника, максимум 64 символа

Параметры completions

<SHELL> обязателен: bash, zsh, fish, powershell или elvish. Актуальные параметры также доступны через linkly <command> --help и в справочнике инструментов.

Начало работы

Основные функции

Подключение ИИ-инструментов

Для ИИ-агентов

Использование Linkly AI CLI

Что такое Linkly AI CLI

Установка

Основные команды

Состояние

Поиск

Структура документа

Поиск шаблона внутри документов

Чтение

Поиск путей

Библиотеки и обзор (list-libraries, explore)

Notes

Диагностика подключения (doctor)

Управление Skills (skills)

Автодополнение

Режим MCP

Обновление

Режимы подключения

Локальный

LAN

Удалённый

Справочник параметров

Глобальные параметры

Коды завершения

Параметры search

Параметры find-paths

Параметры outline

Параметры grep

Параметры read

Параметры list

Параметры note-save

Параметры completions

​Что такое Linkly AI CLI

​Установка

​Основные команды

​Состояние

​Поиск

​Структура документа

​Поиск шаблона внутри документов

​Чтение

​Поиск путей

​Библиотеки и обзор (list-libraries, explore)

​Notes

​Диагностика подключения (doctor)

​Управление Skills (skills)

​Автодополнение

​Режим MCP

​Обновление

​Режимы подключения

​Локальный

​LAN

​Удалённый

​Справочник параметров

​Глобальные параметры

​Коды завершения

​Параметры search

​Параметры find-paths

​Параметры outline

​Параметры grep

​Параметры read

​Параметры list

​Параметры note-save

​Параметры completions

Что такое Linkly AI CLI

Установка

Основные команды

Состояние

Поиск

Структура документа

Поиск шаблона внутри документов

Чтение

Поиск путей

Библиотеки и обзор (list-libraries, explore)

Notes

Диагностика подключения (doctor)

Управление Skills (skills)

Автодополнение

Режим MCP

Обновление

Режимы подключения

Локальный

LAN

Удалённый

Справочник параметров

Глобальные параметры

Коды завершения

Параметры search

Параметры find-paths

Параметры outline

Параметры grep

Параметры read

Параметры list

Параметры note-save

Параметры completions