---
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](/bg/api). MCP: [MCP](/bg/mcp). Умение за агенти: [Умение за агенти](/bg/skill). Цени: [Цени](/bg/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`. Без браузър (headless): задайте в `LINKDASH_TOKEN` сесиен токен, получен от `auth create` или `auth login`. Не измисляйте токени.

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

CLI не може да променя имейла, паролата или плащанията. Насочете потребителя към [таблото](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>` | Създава [папка](/bg/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>` | [Споделя](/bg/sharing) с хора по имейл (повторете `--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>` | Общ брой посещения, изтегляния и пускания, също и по варианти, плюс роботите (crawlers) |
| `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` | Списък с webhook крайни точки (тайната е маскирана) |
| `webhooks get <id>` | Показва URL на един webhook (тайната е маскирана) |
| `webhooks create --url <https>` | Добавя HTTPS крайна точка (тайната се показва веднъж) |
| `webhooks rotate <id>` | Издава нова тайна за подписване |
| `webhooks delete <id>` | Премахва webhook |
| `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 е идентификаторът на връзката и нейният публичен път, когато връзката е публична. Името е видимо само за вас. Новите връзки са ограничени (вижте [Достъп и споделяне](#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 за споделяне (само при обновяване) |
| `--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>` | Създава в тази папка (само при създаване; `--in-domain <host>`, ако slug на папката се повтаря) |
| `--status <active\|paused>` | Пауза или възобновяване (само при обновяване) |
| `--sticky` / `--no-sticky` | Завръщащият се посетител получава същия вариант (по подразбиране sticky) |
| `--restart-split` | Разбърква наново sticky разпределенията (само при обновяване) |
| `--forward-params` / `--no-forward-params` | Добавя query низа на посетителя към URL вариантите (по подразбиране изключено). Вижте [Препращане на query параметри](#forward-query-parameters) |
| `--variant <name>` | Започва блок на вариант (само при създаване). Вижте [Варианти](#variants) |
| `--weight <n>` `--when <key=v1,v2>` | За всеки вариант поотделно. Вижте [Варианти](#variants) и [Правила за query параметри](#query-parameter-rules) |
| `--preview-name <text>` | Публично име при разгъване на прегледа (unfurl) |
| `--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` | Само при обновяване |

`--status` приема само `active` или `paused`. Статусът „изтекла“ идва от `--expires`. Статусът „насрочена“ идва от `--starts`. Преди началния момент публичното разрешаване връща not-found. След достигане на `--max-openings` връзката се поставя на пауза; увеличете числото или използвайте `--clear-max-openings`, за да се обслужва отново. Вече използваните отваряния остават отчетени, докато не промените или премахнете лимита.

Slug-овете в `lida.sh` са общи за всички. Ако дадена дума е заета, добавете [персонализиран домейн](/bg/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"] }`.

### Правила за query параметри

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

| Синтаксис | JSON `op` | Съвпада, когато |
| --- | --- | --- |
| `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?` or `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`). Стойностите на параметрите се сравняват в момента на отваряне и никога не се съхраняват в аналитиката.

### Препращане на query параметри

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

### Sticky и рестартиране на разделянето

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

## Папки

Папката е връзка, която изброява поставените в нея елементи. Вижте [Папки](/bg/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 остава резервиран, докато връзката не е публична. Вижте [Споделяне и достъп](/bg/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 имейла на заявка, 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
```

Вижте също [папки](/bg/folders), [споделяне и достъп](/bg/sharing), [webhooks](/bg/webhooks) и [персонализирани домейни](/bg/domains).
