---
title: CLI
description: >-
  Установите linkdash-cli из npm и запускайте команду `linkdash`. Успешные
  команды выводят JSON в stdout. Справка и ошибки выводятся обычным текстом в
  stderr.
sidebar:
  label: CLI
  order: 3
---
```bash
npm i -g linkdash-cli
# or: pnpm add -g linkdash-cli / bun add -g linkdash-cli / npx linkdash-cli@latest
```

Пакет npm называется `linkdash-cli`. Команда — `linkdash`.

HTTP-аналог: [HTTP API](/ru/api). MCP: [MCP](/ru/mcp). Навык для агентов: [Навык для агентов](/ru/skill). Цены: [Цены](/ru/pricing). Обычный Markdown: [cli.md](https://linkdash.dev/cli.md).

Флага `--json` нет. При ошибках код выхода — 1.

## Аутентификация

```bash
linkdash auth create
linkdash auth login
linkdash auth whoami
linkdash auth logout
```

Ещё нет аккаунта? `auth create` открывает https://linkdash.dev/sign-up, а затем возвращает на https://linkdash.dev/device с кодом CLI, чтобы вы могли подтвердить вход. Аккаунт уже есть? `auth login` открывает `/device`. Без браузера: задайте в `LINKDASH_TOKEN` токен сессии, полученный через `auth create` или `auth login`. Не придумывайте токены.

Файл сессии: `~/.config/linkdash/config.json` (права 0600).

CLI не может изменить email, пароль или настройки оплаты. Направьте пользователя в [панель управления](https://linkdash.dev/dashboard/billing). API-ключи (HTTP и MCP): [API-ключи](https://linkdash.dev/dashboard/keys).

## Команды

```
linkdash <command> [options]
```

| Команда | Что делает |
| --- | --- |
| `auth create` | Регистрация в браузере, затем подтверждение устройства |
| `auth login` | Вход через браузер с подтверждением устройства |
| `auth logout` | Удалить сохранённую сессию |
| `auth whoami` | JSON с данными текущего аккаунта |
| `links list` | Список ссылок и папок постранично (`--limit`, `--cursor`) |
| `links get <id>` | Одна ссылка |
| `links create --url <url>` | Короткая ссылка на URL |
| `links create --file <path>` | Загрузить файл и получить ссылку |
| `links create --text <text>` | Сохранить фрагмент текста |
| `links create --folder <name>` | Создать [папку](/ru/folders) |
| `links create --variant <name> …` | Ссылка с несколькими вариантами (сплит / таргетинг) |
| `links update <id>` | Изменить адрес назначения, файл, пароль, срок действия, домен, статус, закрепление (sticky) или передачу параметров |
| `links move <id> --in <folder-id>` | Поместить ссылку или папку в папку (`--root` — на верхний уровень) |
| `links copy <id>` | Создать копию с новым slug в той же папке |
| `links delete <id>` | Удалить ссылку (элементы папки перемещаются на уровень выше; `--with-contents` удаляет их) |
| `links share <id> --email <email>` | [Открыть доступ](/ru/sharing) людям по email (повторяйте `--email`; `--role editor` позволяет им вносить изменения; каждый новый участник получает письмо-приглашение) |
| `links unshare <id> --email <email>` | Отозвать доступ у человека |
| `links shares [id]` | Кто, кроме вас, может открыть элемент, включая доступ через вышестоящую папку. Без id: всё, к чему вы пригласили людей, постранично (`--limit`, `--cursor`) |
| `links shared` | Чем с вами поделились другие, постранично (`--limit`, `--cursor`) |
| `links leave <_id \| share URL>` | Отказаться от доступа к тому, чем с вами поделились |
| `links role <id> --email <e> --role viewer\|editor` | Сделать приглашённого вами человека читателем или редактором |
| `links unlock <_id \| share URL>` | Ввести пароль общего элемента, чтобы видеть и изменять его цель в течение 30 минут |
| `links activity <id>` | Кто и как изменял элемент |
| `links reset-link <id>` | Новый URL для доступа; старый URL `linkdash.dev/s/` перестаёт работать |
| `links stats <id>` | Итоги по посещениям, скачиваниям и воспроизведениям, в том числе по вариантам, а также краулеры |
| `links export` | Вывести все ссылки в CSV (одна строка на вариант) |
| `links import <file>` | Импортировать строки с URL и текстом из CSV |
| `links variants list <id>` | Варианты ссылки |
| `links variants add <id> --name <n>` | Добавить вариант |
| `links variants update <id> <name>` | Изменить вариант |
| `links variants remove <id> <name>` | Удалить вариант |
| `webhooks list` | Список эндпоинтов вебхуков (секрет скрыт) |
| `webhooks get <id>` | Показать URL одного вебхука (секрет скрыт) |
| `webhooks create --url <https>` | Добавить HTTPS-эндпоинт (секрет показывается один раз) |
| `webhooks rotate <id>` | Выпустить новый секрет подписи |
| `webhooks delete <id>` | Удалить вебхук |
| `domains list` | Список собственных хостов |
| `domains add <host>` | Добавить хост (1 на тарифе Free) |
| `domains connect <host>` | URL применения Domain Connect или null |
| `domains verify <host>` | Проверить DNS через Unkey |
| `domains remove <host>` | Удалить хост |
| `-h, --help` | Справка (обычный текст) |
| `-v, --version` | Версия |

Если один и тот же slug существует на двух доменах владельца, передайте `--domain`.

## Флаги создания и обновления

Slug — это идентификатор ссылки, а для публичной ссылки ещё и её публичный путь. Имя (name) видно только вам. Новые ссылки создаются с ограниченным доступом (см. [Доступ и совместное использование](#access-and-sharing)). Команда create принимает **ровно одно** из следующего: `--url`, `--file` или `--text` (это становится вариантом `main`), блоки `--variant` (см. [Варианты](#variants)) или `--folder <name>` (см. [Папки](#folders)).

| Флаг | Примечания |
| --- | --- |
| `--url <url>` | URL назначения |
| `--file <path>` | Файл для загрузки (при создании или для замены содержимого при обновлении) |
| `--text <text>` | Фрагмент текста |
| `--access <restricted\|link\|public>` | Кто может открыть. По умолчанию `restricted`. См. [Доступ и совместное использование](#access-and-sharing) |
| `--reset-share-link` | Выпустить новый URL для доступа (только update) |
| `--slug <id>` | Публичный путь: `a-z0-9` и дефисы внутри, 1–64 символа |
| `--name <label>` | Приватная метка |
| `--tag <tag>` | Можно повторять. Строчные буквы, без запятых. Максимум 20 |
| `--starts <when>` | Начать работу через `7d`, `24h`, `30m` или с даты в формате ISO |
| `--password <secret>` | Требовать этот пароль для открытия |
| `--expires <when>` | Прекратить работу через `7d`, `24h`, `30m` или с даты в формате ISO |
| `--max-openings <n>` | Приостановить после указанного числа открытий. Не указывайте, если лимит не нужен |
| `--domain <host>` | Обслуживать на этом хосте вместо `lida.sh` |
| `--in <folder-id>` | Создать внутри этой папки (только create; `--in-domain <host>`, если slug папки повторяется) |
| `--status <active\|paused>` | Приостановить или возобновить (только update) |
| `--sticky` / `--no-sticky` | Вернувшийся посетитель получает тот же вариант (по умолчанию sticky включён) |
| `--restart-split` | Перераспределить закреплённые назначения (только update) |
| `--forward-params` / `--no-forward-params` | Добавлять строку запроса посетителя к URL-вариантам (по умолчанию выключено). См. [Передача параметров запроса](#forward-query-parameters) |
| `--variant <name>` | Начать блок варианта (только create). См. [Варианты](#variants) |
| `--weight <n>` `--when <key=v1,v2>` | Для каждого варианта. См. [Варианты](#variants) и [Правила для параметров запроса](#query-parameter-rules) |
| `--preview-name <text>` | Публичное название в превью ссылки |
| `--preview-description <text>` | Публичное описание в превью ссылки |
| `--preview-image <path>` | Публичное изображение в превью ссылки |
| `--utm-source` `--utm-medium` `--utm-campaign` `--utm-term` `--utm-content` | Только для URL-ссылок |
| `--clear-password` `--clear-expires` `--clear-starts` `--clear-tags` `--clear-preview` `--clear-name` `--clear-max-openings` | Только update |

`--status` принимает только `active` или `paused`. Статус expired задаётся через `--expires`, scheduled — через `--starts`. До момента старта публичный адрес возвращает not-found. Когда лимит `--max-openings` достигнут, ссылка приостанавливается; чтобы она снова работала, увеличьте число или используйте `--clear-max-openings`. Уже использованные открытия учитываются, пока вы не измените или не снимете лимит.

Пространство slug на `lida.sh` общее для всех. Если слово занято, добавьте [собственный домен](/ru/domains) и повторите команду с `--domain`. Ссылка на брендированном домене не публикуется дополнительно на `lida.sh`.

## Флаги списка

Выводит одну страницу, `{items, cursor}`: `--limit` — от 1 до 100 (по умолчанию 50); передавайте в `--cursor` значение `cursor` с предыдущей страницы, пока оно не станет `null`. Страница может содержать меньше элементов, чем `--limit`, если фильтр часть из них пропустил. `--q` ищет по целым словам, последнее слово — как префикс (`laun` находит `example.com/launch`), результаты ранжируются по релевантности; `--in` выводит содержимое одной папки, сначала папки; в остальных случаях — сначала новые.

| Флаг | Примечания |
| --- | --- |
| `--limit <n>` | Элементов на странице, 1-100 (по умолчанию 50) |
| `--cursor <c>` | Значение `cursor` с предыдущей страницы |
| `--q <text>` | Поиск слов в имени, slug, названиях и целях вариантов, именах файлов, тексте фрагментов и тегах |
| `--tag <tag>` | Фильтр по тегу |
| `--kind <url\|file\|text\|folder\|group>` | Фильтр по типу (`group` — несколько вариантов) |
| `--status <status>` | `active`, `paused`, `expired`, `scheduled` или `mixed` |
| `--in <folder-id\|root>` | Только то, что находится непосредственно в этой папке или на верхнем уровне. Без флага выводится всё |

## Варианты

Каждая ссылка — это контейнер для одного или нескольких **вариантов**. Вариант — это содержимое (URL, файл или текст) плюс собственные ограничения (`--password`, `--starts`, `--expires`, `--max-openings`), вес `--weight` и необязательные условия для посетителя (`--when`). Без `--variant` у ссылки один вариант с именем `main`, и все команды выше — сокращённая запись для него. Посетитель получает один вариант: варианты, у которых совпадает `--when`, образуют пул (если совпадений нет, пул образуют варианты без условий), затем выбор делается с учётом весов. При закреплении (sticky, по умолчанию) вернувшийся посетитель получает тот же вариант. Ограничения самой ссылки имеют приоритет над ограничениями вариантов. Имена вариантов: строчные буквы, цифры, дефисы внутри, 1–40 символов, уникальны в пределах ссылки. Максимум 20 вариантов.

`kind` ссылки — это тип варианта, если вариант один, и `group`, если их несколько. `status` ссылки — это статус ограничения ссылки, если оно задано (`paused`, `scheduled`, `expired`), иначе общий статус вариантов, иначе `mixed`. `variantStatuses` содержит количество вариантов по статусам `{active, paused, expired, scheduled}`.

### Создание с блоками вариантов

```bash
linkdash links create --slug promo --variant a --url https://example.com/a --variant b --url https://example.com/b --weight 3
linkdash links create --slug hi --variant de --url https://example.de --when country=DE,AT --variant rest --url https://example.com
```

`--variant <name>` начинает блок варианта. Флаги после него относятся к этому варианту до следующего `--variant`: `--url|--file|--text`, `--password`, `--starts`, `--expires`, `--max-openings`, `--weight <n>`, `--when <key=v1,v2>` (можно повторять), `--utm-*`. Флаги ссылки (`--slug --name --tag --domain --preview-* --password --starts --expires --max-openings --sticky --no-sticky --forward-params`) указываются до первого `--variant`.

### Подкоманды для вариантов

```bash
linkdash links variants list promo
linkdash links variants add promo --name mobile --url https://m.example.com --when device=mobile
linkdash links variants update promo mobile --when country=DE,AT --when device=mobile --weight 2
linkdash links variants update promo b --status paused
linkdash links variants remove promo b
```

`variants add <id> --name <n>` принимает один из флагов `--url`, `--file`, `--text`, а также флаги ограничений, `--weight`, `--when`, `--utm-*`. `variants update <id> <name>` принимает `--name <new>`, содержимое, флаги ограничений, `--status active|paused`, `--weight`, `--when`, `--clear-when`, `--clear-password`, `--clear-starts`, `--clear-expires`, `--clear-max-openings`. У ссылки всегда остаётся хотя бы один вариант.

### Ключи `--when`

| Ключ | Поле JSON | Значения |
| --- | --- | --- |
| `country` | `countries` | Коды ISO-2 (`DE`, `AT`) |
| `device` | `devices` | `mobile` `tablet` `desktop` |
| `os` | `os` | `windows` `macos` `android` `ios` `linux` `other` |
| `browser` | `browsers` | `edge` `chrome` `firefox` `safari` `other` |
| `language` | `languages` | совпадение по префиксу (`de`, `en-us`) |
| `referrer` | `referrerHosts` | суффикс хоста (`twitter.com`) |

Должны совпасть все заданные ключи. `--when country=DE,AT --when device=mobile` соответствует `{ "countries": ["DE","AT"], "devices": ["mobile"] }`.

### Правила для параметров запроса

`--when` также принимает правила `param:` для строки запроса посетителя (`lida.sh/promo?src=newsletter`). Ключи чувствительны к регистру, значения сравниваются точно, не более 10 правил на вариант. Запятые разделяют значения в `--when`, поэтому значение параметра не может содержать запятую; для списков используйте `|`.

| Синтаксис | `op` в JSON | Совпадает, если |
| --- | --- | --- |
| `param:KEY=VALUE` | `equals` | значение в точности равно `VALUE` |
| `param:KEY!=VALUE` | `notEquals` | значение отличается или ключ отсутствует |
| `param:KEY~=VALUE` | `includes` | значение содержит `VALUE` |
| `param:KEY^=VALUE` | `startsWith` | значение начинается с `VALUE` |
| `param:KEY$=VALUE` | `endsWith` | значение заканчивается на `VALUE` |
| `param:KEY=v1\|v2` | `in` | значение входит в список |
| `param:KEY?` или `param:KEY` | `exists` | ключ присутствует |
| `param:!KEY` | `missing` | ключ отсутствует |

```bash
linkdash links variants add promo --name news --url https://example.com/news --when param:src=newsletter
linkdash links variants add promo --name pro --url https://example.com/pro --when "param:plan~=pro"
linkdash links variants add promo --name ref --url https://example.com/ref --when "param:ref?"
```

Структура JSON: `"when": { "params": [{ "key": "src", "op": "equals", "value": "newsletter" }] }` (`value` не указывается для `exists` / `missing`). Значения параметров проверяются в момент открытия и никогда не сохраняются в аналитике.

### Передача параметров запроса

`--forward-params` / `--no-forward-params` в `links create` и `links update` (на уровне ссылки, по умолчанию выключено) добавляет всю строку запроса посетителя к URL-вариантам: `lida.sh/promo?src=nl` открывает `https://example.com/?src=nl`. Значения посетителя переопределяют сохранённые, включая `--utm-*`. Варианты с файлом и текстом эту настройку игнорируют. Это маршрутизация, а не контроль доступа: добавить параметры может кто угодно. Значения параметров не сохраняются в аналитике. `links get` показывает эту настройку как `forwardParams`.

### Закрепление и перезапуск сплита

`links update <id> --sticky` / `--no-sticky` определяет, получает ли вернувшийся посетитель тот же вариант. `links update <id> --restart-split` перераспределяет закреплённые назначения. Флаги содержимого в `links update` работают только для ссылок с одним вариантом; в остальных случаях используйте `links variants update <id> <name>`.

## Папки

Папка — это ссылка, которая показывает список помещённых в неё элементов. О том, как работают публичная страница и доступ, см. [Папки](/ru/folders).

```bash
linkdash links create --folder "Q4 launch" --slug q4
linkdash links create --file ./deck.pdf --in q4
linkdash links move k3m9xq --in q4
linkdash links move k3m9xq --root
linkdash links list --in q4
linkdash links copy k3m9xq
linkdash links delete q4 --with-contents
```

`--folder <name>` задаёт имя папки (не `--name`) и принимает `--slug`, `--domain`, `--password`, `--starts`, `--expires`, `--max-openings`, `--tag`, `--preview-*` и `--in`. Его нельзя сочетать с `--url`, `--file`, `--text` или `--variant`. `links move` выводит `{id, folder}`. `links copy` сохраняет уровень доступа, но копия получает новый URL для доступа; люди не копируются. `links delete` для папки перемещает её элементы на уровень выше; `--with-contents` удаляет и их. Строки в выводе list, get и create содержат `folder` (slug родительской папки или `null`); строки папок также содержат `items`.

## Доступ и совместное использование

Новые ссылки и папки имеют доступ `restricted`: их `url` — `https://linkdash.dev/s/<token>`, и открыть его можете только вы и люди, с которыми вы поделились, после входа в аккаунт. `--access link` делает этот URL доступным всем, у кого он есть. `--access public` обслуживает ссылку по её короткому URL (`lida.sh/<slug>` или ваш собственный домен). Используйте `--access public` для ссылок, которые вы публикуете открыто. Slug остаётся идентификатором для всех команд, а его короткий URL остаётся зарезервированным, пока ссылка не публичная. Полное описание модели см. в разделе [Совместный доступ и права](/ru/sharing).

```bash
linkdash links create --url https://example.com/launch --access public
linkdash links share q4 --email anna@example.com --email ben@example.com
linkdash links shares q4
linkdash links unshare q4 --email ben@example.com
linkdash links shared
linkdash links leave https://linkdash.dev/s/<token>
linkdash links share q4 --email cara@example.com --role editor
linkdash links role q4 --email cara@example.com --role viewer
linkdash links unlock https://linkdash.dev/s/<token>
linkdash links activity q4
linkdash links shares
linkdash links update q4 --access link
linkdash links reset-link q4
```

| Команда | Выводит |
| --- | --- |
| `links share <id> --email <e> [--email <e> …]` | `{id, url, access, invited, alreadyShared}` |
| `links unshare <id> --email <e>` | `{id, email, removed: true}` |
| `links shares <id>` | `{id, access, url, people: [{email, role: "viewer", accepted, invitedAt, viaFolder?}]}` |
| `links shares` (без id) | `{items: [{id, name?, kind, access, url, people: [{email, accepted, invitedAt}]}], cursor}`, сначала те, к которым доступ открыт недавно |
| `links shared` | `{items: [{_id, _creationTime, kind, title?, status, hasPassword, access, url, itemCount?, sharedBy?, sharedAt}], cursor}`, сначала новые |
| `links leave <_id \| share URL>` | `{_id, left: true}` |
| `links role <id> --email <e> --role <r>` | `{id, email, role}` |
| `links unlock <_id \| share URL>` | `{_id, variant, unlocked: true, minutes: 30, kind, destinationUrl? \| textContent? \| fileName?}` |
| `links activity <id>` | `{items: [{_id, _creationTime, action, detail?, actor}], cursor}` |
| `links reset-link <id>` (или `links update <id> --reset-share-link`) | `{id, access, url}` |

`--role editor` делает человека редактором: редактор может изменять элемент и видеть его статистику, но не может менять пароли, slug, домен, доступ и совместное использование, а также удалять, перемещать или копировать элемент; для цели, защищённой паролем, сначала нужен `links unlock` (на 30 минут). Редакторы используют `_id` или URL для доступа из `links shared`. Все команды принимают `--domain <host>`, если slug повторяется. `url` в выводе `create`, `get`, `list`, `update`, `copy` и `share` — это URL для доступа, а для публичной ссылки — короткий URL; строки содержат `access`. До 200 человек на элемент, 50 адресов email за вызов, 100 писем-приглашений на аккаунт в день. Оба списка выводят одну страницу: `--limit` — от 1 до 100 (по умолчанию 50); передавайте `--cursor` с предыдущей страницы, пока `cursor` не станет `null`. `links leave` принимает `_id` или `url` из `links shared`; доступ через вышестоящую общую папку сохраняется. Открытие доступа, его отзыв, изменение уровня доступа и сброс ссылки считаются одним событием каждое; выход из доступа — нет.

## Статистика

```bash
linkdash links stats <id> --last 24h
```

`--last` — длительность (`24h`, `7d`). По умолчанию `24h`. JSON содержит `visits`, `downloads`, `plays`, `visitsInLast`, `countries`, `referrers`, `variants` (итоги по вариантам), `visitors` (у каждого указан `variant`) и `crawlers` (`[{crawler, company, category, hits, lastSeen}]`: боты и сервисы превью ссылок, которые запрашивали ссылку; они никогда не учитываются как посещения).

## CSV

Столбцы: `slug,kind,name,variant,url,text,fileName,status,domain,tags,starts,expires,maxOpenings,weight,when,created,folder,access`. Одна строка на вариант. `kind`, `status`, `url`, `text`, `fileName`, `weight` и `when` (строка JSON) относятся к варианту; остальные относятся к ссылке и повторяются. `folder` — slug папки, в которой находится ссылка. `access` — `restricted`, `link` или `public`. Пароли, токены доступа и люди не экспортируются.

```bash
linkdash links export > links.csv
linkdash links import links.csv
```

Импорт группирует строки по slug + домен. Первая строка создаёт ссылку с её вариантом; последующие строки добавляют варианты. Для существующей ссылки первая строка обновляет поля ссылки, затем каждая строка обновляет вариант с тем же именем, если он есть, или добавляет новый. Строки с файлами без содержимого пропускаются с ошибкой для этой строки. Строки с `kind` = `folder` (с заполненным `name`) создают папки; столбец `folder` помещает каждую ссылку в её папку после того, как созданы все строки. Пустое значение `access` делает новые ссылки ограниченными и не меняет существующие.

## Примеры

```bash
linkdash links create --url https://example.com/q4/deck.pdf --slug deck --name "Q4 deck"
linkdash links create --file ./deck.pdf --expires 7d --starts 1d
linkdash links create --url https://example.com --max-openings 1
linkdash links update k3m9xq --max-openings 5
linkdash links update k3m9xq --clear-max-openings
linkdash links create --text "release checklist" --tag launch --tag q4
linkdash links list --q deck --tag launch --kind file --status paused
linkdash links get welcome --domain go.example.com
linkdash links update deck --file ./new.pdf
linkdash links update k3m9xq --status paused
linkdash links create --slug promo --variant a --url https://example.com/a --variant b --url https://example.com/b --weight 3
linkdash links variants add promo --name mobile --url https://m.example.com --when device=mobile
linkdash links update promo --no-sticky --restart-split
linkdash links create --folder "Q4 launch" --slug q4
linkdash links move k3m9xq --in q4
linkdash links create --url https://example.com/launch --access public
linkdash links share q4 --email anna@example.com
```

См. также [папки](/ru/folders), [совместный доступ и права](/ru/sharing), [вебхуки](/ru/webhooks) и [собственные домены](/ru/domains).
