Przejdź do treści
LinkdashLinkdash
Polski
Esc
↑↓nawigacja↵otwórz⌘Jpodgląd
Na tej stronie

CLI

Zainstaluj linkdash-cli z npm, a potem uruchom polecenie `linkdash`. Udane polecenia wypisują JSON na stdout. Pomoc i błędy trafiają jako zwykły tekst na stderr.

npm i -g linkdash-cli
# or: pnpm add -g linkdash-cli / bun add -g linkdash-cli / npx linkdash-cli@latest

Pakiet npm to linkdash-cli. Polecenie to linkdash.

Odpowiednik HTTP: HTTP API. MCP: MCP. Skill dla agentów: Skill dla agentów. Cennik: Cennik. Czysty markdown: cli.md.

Nie ma flagi --json. Przy błędach kod wyjścia to 1.

Uwierzytelnianie

linkdash auth create
linkdash auth login
linkdash auth whoami
linkdash auth logout

Nie masz jeszcze konta? auth create otwiera https://linkdash.dev/sign-up, a potem wraca na https://linkdash.dev/device z kodem CLI do zatwierdzenia. Masz już konto? auth login otwiera /device. Bez przeglądarki (headless): ustaw LINKDASH_TOKEN na token sesji z auth create lub auth login. Nie wymyślaj tokenów.

Plik sesji: ~/.config/linkdash/config.json (uprawnienia 0600).

CLI nie zmieni adresu e-mail, hasła ani płatności. Odeślij użytkownika do panelu. Klucze API (HTTP i MCP): Klucze API.

Polecenia

linkdash <command> [options]
Polecenie Co robi
auth create Rejestracja w przeglądarce, potem zatwierdzenie urządzenia
auth login Logowanie urządzenia przez przeglądarkę
auth logout Usuwa zapisaną sesję
auth whoami JSON zalogowanego konta
links list Lista linków i folderów, strona po stronie (--limit, --cursor)
links get <id> Jeden link
links create --url <url> Krótki link z URL-a
links create --file <path> Prześlij plik i dostań link
links create --text <text> Zapisz fragment tekstu
links create --folder <name> Utwórz folder
links create --variant <name> … Link z kilkoma wariantami (podział / targetowanie)
links update <id> Zmień cel, plik, hasło, datę wygaśnięcia, domenę, status, przypisanie sticky lub przekazywane parametry
links move <id> --in <folder-id> Umieść link lub folder w folderze (--root dla najwyższego poziomu)
links copy <id> Utwórz kopię z nowym slugiem w tym samym folderze
links delete <id> Usuń link (elementy folderu przechodzą poziom wyżej; --with-contents je usuwa)
links share <id> --email <email> Udostępnij osobom przez e-mail (powtórz --email; --role editor pozwala im go zmieniać; każda nowa osoba dostaje e-mail z zaproszeniem)
links unshare <id> --email <email> Odbierz komuś dostęp
links shares [id] Kto poza tobą może to otworzyć, także przez folder wyżej. Bez id: wszystko, co komuś udostępniasz, strona po stronie (--limit, --cursor)
links shared Co inni udostępnili tobie, strona po stronie (--limit, --cursor)
links leave <_id | share URL> Zrezygnuj z czegoś, co ci udostępniono
links role <id> --email <e> --role viewer|editor Nadaj zaproszonej przez ciebie osobie rolę przeglądającego lub edytora
links unlock <_id | share URL> Podaj hasło udostępnionego elementu, żeby przez 30 minut widzieć i edytować jego cel
links activity <id> Kto zmienił element i w jaki sposób
links reset-link <id> Nowy URL udostępniania; stary URL linkdash.dev/s/ przestaje działać
links stats <id> Sumy wizyt, pobrań i odtworzeń, także dla każdego wariantu, plus crawlery
links export Wypisz wszystkie linki jako CSV (jeden wiersz na wariant)
links import <file> Importuj wiersze URL i tekstowe z CSV
links variants list <id> Warianty linku
links variants add <id> --name <n> Dodaj wariant
links variants update <id> <name> Zmień wariant
links variants remove <id> <name> Usuń wariant
webhooks list Lista endpointów webhooków (sekret zamaskowany)
webhooks get <id> Pokaż URL jednego webhooka (sekret zamaskowany)
webhooks create --url <https> Dodaj endpoint HTTPS (sekret widoczny tylko raz)
webhooks rotate <id> Wygeneruj nowy sekret podpisu
webhooks delete <id> Usuń webhook
domains list Lista własnych nazw hostów
domains add <host> Dodaj nazwę hosta (1 w planie Free)
domains connect <host> URL zastosowania Domain Connect albo null
domains verify <host> Sprawdź DNS przez Unkey
domains remove <host> Usuń nazwę hosta
-h, --help Pomoc (zwykły tekst)
-v, --version Wersja

Jeśli ten sam slug istnieje w dwóch domenach właściciela, podaj --domain.

Flagi tworzenia i aktualizacji

Slug to id linku, a gdy link jest publiczny – także jego publiczna ścieżka. Nazwę widzisz tylko ty. Nowe linki mają dostęp ograniczony (zobacz Dostęp i udostępnianie). Tworzenie przyjmuje dokładnie jedno z: --url, --file lub --text (staje się wariantem main), bloki --variant (zobacz Warianty) albo --folder <name> (zobacz Foldery).

Flaga Uwagi
--url <url> Docelowy URL
--file <path> Plik do przesłania (przy tworzeniu albo do podmiany zawartości przy aktualizacji)
--text <text> Fragment tekstu
--access <restricted|link|public> Kto może go otworzyć. Domyślnie restricted. Zobacz Dostęp i udostępnianie
--reset-share-link Wygeneruj nowy URL udostępniania (tylko aktualizacja)
--slug <id> Publiczna ścieżka: a-z0-9 i myślniki wewnątrz, 1–64
--name <label> Prywatna etykieta
--tag <tag> Można powtarzać. Małe litery, bez przecinków. Maks. 20
--starts <when> Uruchom po 7d, 24h, 30m albo od daty ISO
--password <secret> Wymagaj tego hasła do otwarcia
--expires <when> Przestań serwować po 7d, 24h, 30m albo od daty ISO
--max-openings <n> Wstrzymaj po tylu otwarciach. Pomiń, żeby nie ustawiać limitu
--domain <host> Serwuj na tym hoście zamiast lida.sh
--in <folder-id> Utwórz w tym folderze (tylko tworzenie; --in-domain <host>, jeśli slug folderu się powtarza)
--status <active|paused> Wstrzymaj lub wznów (tylko aktualizacja)
--sticky / --no-sticky Powracający odwiedzający dostaje ten sam wariant (domyślnie sticky)
--restart-split Przetasuj przypisania sticky (tylko aktualizacja)
--forward-params / --no-forward-params Dokleja query string odwiedzającego do wariantów URL (domyślnie wyłączone). Zobacz Przekazywanie parametrów zapytania
--variant <name> Rozpocznij blok wariantu (tylko tworzenie). Zobacz Warianty
--weight <n> --when <key=v1,v2> Dla każdego wariantu. Zobacz Warianty i Reguły parametrów zapytania
--preview-name <text> Publiczna nazwa w podglądzie linku
--preview-description <text> Publiczny opis w podglądzie linku
--preview-image <path> Publiczny obrazek w podglądzie linku
--utm-source --utm-medium --utm-campaign --utm-term --utm-content Tylko linki URL
--clear-password --clear-expires --clear-starts --clear-tags --clear-preview --clear-name --clear-max-openings Tylko aktualizacja

--status przyjmuje tylko active lub paused. Status „expired” wynika z --expires. Status „scheduled” wynika z --starts. Do momentu startu publiczne rozwiązanie linku zwraca not-found. Po osiągnięciu --max-openings link się wstrzymuje; zwiększ liczbę albo użyj --clear-max-openings, żeby znowu go serwować. Wykorzystane już otwarcia są liczone, dopóki nie zmienisz lub nie usuniesz limitu.

Slugi w lida.sh są wspólne dla wszystkich. Jeśli słowo jest zajęte, dodaj własną domenę i spróbuj ponownie z --domain. Link na domenie firmowej nie jest jednocześnie publikowany w lida.sh.

Flagi listowania

Wypisuje jedną stronę, {items, cursor}: --limit to 1-100 (domyślnie 50); przekazuj --cursor z wartością cursor z poprzedniej strony, aż będzie null. Strona może zawierać mniej elementów niż --limit, gdy filtr część pominie. --q dopasowuje całe słowa, a ostatnie jako prefiks (laun znajdzie example.com/launch), z sortowaniem według trafności; --in listuje jeden folder, najpierw foldery; w pozostałych przypadkach od najnowszych.

Flaga Uwagi
--limit <n> Elementów na stronę, 1-100 (domyślnie 50)
--cursor <c> cursor z poprzedniej strony
--q <text> Szukaj słów w nazwie, slugu, nazwach i celach wariantów, nazwach plików, tekście fragmentów i tagach
--tag <tag> Filtruj po tagu
--kind <url|file|text|folder|group> Filtruj po rodzaju (group = kilka wariantów)
--status <status> active, paused, expired, scheduled lub mixed
--in <folder-id|root> Tylko to, co jest bezpośrednio w tym folderze lub na najwyższym poziomie. Bez tej flagi listowane jest wszystko

Warianty

Każdy link jest kontenerem na jeden lub więcej wariantów. Wariant to treść (URL, plik lub tekst) plus własne warunki dostępu (--password, --starts, --expires, --max-openings), --weight i opcjonalne warunki dotyczące odwiedzającego (--when). Bez --variant link ma jeden wariant o nazwie main, a każde z powyższych poleceń jest dla niego skrótem. Odwiedzający dostaje jeden wariant: pulę tworzą warianty, których --when pasuje (jeśli żaden nie pasuje – warianty bez warunków), a potem następuje losowanie ważone. Przy przypisaniu sticky (domyślnym) powracający odwiedzający dostaje ten sam wariant. Warunki dostępu samego linku mają pierwszeństwo przed warunkami wariantów. Nazwy wariantów: małe litery, cyfry, myślniki wewnątrz, 1–40 znaków, unikalne w obrębie linku. Maks. 20 wariantów.

kind linku to rodzaj wariantu, gdy wariant jest jeden, lub group, gdy jest ich kilka. status linku to stan warunków dostępu linku, jeśli jest ustawiony (paused, scheduled, expired), w przeciwnym razie wspólny status wariantów, a jeśli takiego nie ma – mixed. variantStatuses zlicza {active, paused, expired, scheduled}.

Tworzenie z blokami wariantów

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> rozpoczyna blok wariantu. Flagi po nim należą do tego wariantu aż do następnego --variant: --url|--file|--text, --password, --starts, --expires, --max-openings, --weight <n>, --when <key=v1,v2> (można powtarzać), --utm-*. Flagi linku (--slug --name --tag --domain --preview-* --password --starts --expires --max-openings --sticky --no-sticky --forward-params) umieszczasz przed pierwszym --variant.

Podpolecenia wariantów

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> przyjmuje jedno z --url, --file, --text oraz flagi warunków dostępu, --weight, --when, --utm-*. variants update <id> <name> przyjmuje --name <new>, treść, flagi warunków dostępu, --status active|paused, --weight, --when, --clear-when, --clear-password, --clear-starts, --clear-expires, --clear-max-openings. Link zawsze ma co najmniej jeden wariant.

Klucze --when

Klucz Pole JSON Wartości
country countries Kody 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 dopasowanie prefiksu (de, en-us)
referrer referrerHosts sufiks hosta (twitter.com)

Każdy ustawiony klucz musi pasować. --when country=DE,AT --when device=mobile to { "countries": ["DE","AT"], "devices": ["mobile"] }.

Reguły parametrów zapytania

--when przyjmuje też reguły param: dotyczące query stringa odwiedzającego (lida.sh/promo?src=newsletter). Wielkość liter w kluczach ma znaczenie, wartości są porównywane dokładnie, maks. 10 reguł na wariant. Przecinki rozdzielają --when, więc wartość parametru nie może zawierać przecinka; do list używaj |.

Składnia op w JSON Pasuje, gdy
param:KEY=VALUE equals wartość to dokładnie VALUE
param:KEY!=VALUE notEquals wartość jest inna albo klucza brak
param:KEY~=VALUE includes wartość zawiera VALUE
param:KEY^=VALUE startsWith wartość zaczyna się od VALUE
param:KEY$=VALUE endsWith wartość kończy się na VALUE
param:KEY=v1|v2 in wartość jest jedną z listy
param:KEY? lub param:KEY exists klucz występuje
param:!KEY missing klucza brak
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?"

Kształt JSON: "when": { "params": [{ "key": "src", "op": "equals", "value": "newsletter" }] } (value jest pomijane dla exists / missing). Wartości parametrów są dopasowywane w momencie otwarcia i nigdy nie są zapisywane w analityce.

Przekazywanie parametrów zapytania

--forward-params / --no-forward-params w links create i links update (na poziomie linku, domyślnie wyłączone) dokleja cały query string odwiedzającego do wariantów URL: lida.sh/promo?src=nl otwiera https://example.com/?src=nl. Wartości odwiedzającego nadpisują zapisane, łącznie z --utm-*. Warianty plikowe i tekstowe to ignorują. To routing, a nie kontrola dostępu: każdy może dodać parametry. Wartości parametrów nie są zapisywane w analityce. links get pokazuje to ustawienie jako forwardParams.

Sticky i restart podziału

links update <id> --sticky / --no-sticky określa, czy powracający odwiedzający dostaje ten sam wariant. links update <id> --restart-split tasuje od nowa przypisania sticky. Flagi treści w links update działają tylko dla linków z jednym wariantem; w pozostałych przypadkach użyj links variants update <id> <name>.

Foldery

Folder to link, który wyświetla listę elementów, które do niego wkładasz. Jak działają strona publiczna i dostęp, opisuje strona Foldery.

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> ustawia nazwę folderu (nie --name) i przyjmuje --slug, --domain, --password, --starts, --expires, --max-openings, --tag, --preview-* oraz --in. Nie można go łączyć z --url, --file, --text ani --variant. links move wypisuje {id, folder}. links copy zachowuje poziom dostępu, ale dostaje nowy URL udostępniania; osoby nie są kopiowane. links delete na folderze przenosi jego elementy poziom wyżej; --with-contents usuwa również je. Wiersze z list, get i create zawierają folder (slug folderu nadrzędnego albo null); wiersze folderów zawierają też items.

Dostęp i udostępnianie

Nowe linki i foldery mają dostęp restricted: ich url to https://linkdash.dev/s/<token>, który mogą otworzyć tylko ty i osoby, którym go udostępnisz, po zalogowaniu. --access link otwiera ten URL dla każdego, kto go ma. --access public serwuje link pod jego krótkim URL-em (lida.sh/<slug> lub twoja własna domena). Używaj --access public dla linków, które publikujesz publicznie. Slug pozostaje id we wszystkich poleceniach, a jego krótki URL jest zarezerwowany, dopóki link nie jest publiczny. Pełny model opisuje strona Udostępnianie i dostęp.

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
Polecenie Wypisuje
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 (bez id) {items: [{id, name?, kind, access, url, people: [{email, accepted, invitedAt}]}], cursor}, najpierw ostatnio udostępnione
links shared {items: [{_id, _creationTime, kind, title?, status, hasPassword, access, url, itemCount?, sharedBy?, sharedAt}], cursor}, od najnowszych
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> (lub links update <id> --reset-share-link) {id, access, url}

--role editor robi z kogoś edytora: może zmieniać element i widzieć jego statystyki, ale nie hasła, slug, domenę, dostęp ani udostępnianie, nie może też usuwać, przenosić ani kopiować, a cel chroniony hasłem wymaga najpierw links unlock (30 minut). Edytorzy używają _id lub URL-a udostępniania z links shared. Wszystkie polecenia przyjmują --domain <host>, gdy slug się powtarza. url w wyniku create, get, list, update, copy i share to URL udostępniania, chyba że link jest publiczny – wtedy to krótki URL; wiersze zawierają access. Do 200 osób na element, 50 adresów e-mail na wywołanie, 100 e-maili z zaproszeniami na konto dziennie. Obie listy wypisują jedną stronę: --limit to 1-100 (domyślnie 50); przekazuj --cursor z poprzedniej strony, aż cursor będzie null. links leave przyjmuje _id lub url z links shared; dostęp przez udostępniony folder wyżej zostaje. Udostępnienie, cofnięcie udostępnienia, zmiana dostępu i reset liczą się każde jako jedno zdarzenie; opuszczenie – nie.

Statystyki

linkdash links stats <id> --last 24h

--last to okres (24h, 7d). Domyślnie 24h. JSON zawiera visits, downloads, plays, visitsInLast, countries, referrers, variants (sumy dla poszczególnych wariantów), visitors (każdy z variant) oraz crawlers ([{crawler, company, category, hits, lastSeen}]: boty i generatory podglądów linków, które pobrały link; nigdy nie są liczone jako wizyty).

CSV

Kolumny: slug,kind,name,variant,url,text,fileName,status,domain,tags,starts,expires,maxOpenings,weight,when,created,folder,access. Jeden wiersz na wariant. kind, status, url, text, fileName, weight i when (string JSON) dotyczą wariantu; reszta dotyczy linku i się powtarza. folder to slug folderu, w którym jest link. access to restricted, link lub public. Bez haseł, tokenów udostępniania i osób.

linkdash links export > links.csv
linkdash links import links.csv

Import grupuje wiersze po slugu + domenie. Pierwszy wiersz tworzy link z jego wariantem; kolejne wiersze dodają warianty. Dla istniejącego linku pierwszy wiersz aktualizuje pola linku, a potem każdy wiersz aktualizuje wariant o danej nazwie, jeśli istnieje, a w przeciwnym razie go dodaje. Wiersze plików bez zawartości są pomijane z błędem dla danego wiersza. Wiersze z kind = folder (z name) tworzą foldery; kolumna folder umieszcza każdy link w jego folderze, gdy już istnieją wszystkie wiersze. Puste access sprawia, że nowe linki mają dostęp ograniczony, a istniejące zostają bez zmian.

Przykłady

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

Zobacz też foldery, udostępnianie i dostęp, webhooki i własne domeny.

Czy ta strona była pomocna?