Skip to content
LinkdashLinkdash
Lietuvių
Esc
↑↓navigate↵open⌘Jpreview
On this page

CLI

Įdiekite linkdash-cli iš npm, tada paleiskite komandą `linkdash`. Sėkmingai įvykdytos komandos išveda JSON į stdout. Pagalba ir klaidos pateikiamos paprastu tekstu į stderr.

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

npm paketas vadinasi linkdash-cli. Komanda vadinasi linkdash.

HTTP atitikmuo: HTTP API. MCP: MCP. Agento įgūdis: Agento įgūdis. Kainodara: Kainodara. Paprastas markdown: cli.md.

Parinkties --json nėra. Įvykus klaidai, išėjimo kodas yra 1.

Autentifikavimas

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

Dar neturite paskyros? auth create atidaro https://linkdash.dev/sign-up, tada grąžina jus į https://linkdash.dev/device su CLI kodu, kad galėtumėte patvirtinti. Jau turite paskyrą? auth login atidaro /device. Aplinkoje be naršyklės (headless) nustatykite LINKDASH_TOKEN reikšmę: sesijos žetoną, gautą su auth create arba auth login. Neišgalvokite žetonų.

Sesijos failas: ~/.config/linkdash/config.json (režimas 0600).

CLI negali pakeisti el. pašto, slaptažodžio ar atsiskaitymo nustatymų. Nukreipkite naudotoją į valdymo skydelį. API raktai (HTTP ir MCP): API raktai.

Komandos

linkdash <command> [options]
Komanda Ką ji daro
auth create Registracija naršyklėje, tada įrenginio patvirtinimas
auth login Prisijungimas naršyklėje per įrenginio kodą
auth logout Pamiršta išsaugotą sesiją
auth whoami Prisijungusios paskyros JSON
links list Išvardija nuorodas ir aplankus, po vieną puslapį (--limit, --cursor)
links get <id> Viena nuoroda
links create --url <url> Trumpoji nuoroda iš URL
links create --file <path> Įkelia failą ir sukuria nuorodą
links create --text <text> Išsaugo teksto fragmentą
links create --folder <name> Sukuria aplanką
links create --variant <name> … Nuoroda su keliais variantais (skaidymas / taikymas)
links update <id> Pakeičia paskirties adresą, failą, slaptažodį, galiojimo pabaigą, domeną, būseną, pastovumą (sticky) arba perduodamus parametrus
links move <id> --in <folder-id> Perkelia nuorodą ar aplanką į aplanką (--root – į viršutinį lygį)
links copy <id> Sukuria kopiją su nauju slug tame pačiame aplanke
links delete <id> Ištrina nuorodą (aplanko elementai perkeliami lygiu aukščiau; --with-contents juos ištrina)
links share <id> --email <email> Bendrina su žmonėmis pagal el. pašto adresą (kartokite --email; --role editor leidžia jiems keisti elementą; kiekvienas naujas asmuo gauna kvietimo laišką)
links unshare <id> --email <email> Atima asmens prieigą
links shares [id] Kas, be jūsų, gali jį atidaryti, įskaitant prieigą per aukščiau esantį aplanką. Be id: viskas, į ką pakvietėte žmones, po vieną puslapį (--limit, --cursor)
links shared Ką kiti žmonės bendrino su jumis, po vieną puslapį (--limit, --cursor)
links leave <_id | share URL> Atsisako su jumis bendrinamo elemento
links role <id> --email <e> --role viewer|editor Padaro jūsų pakviestą asmenį žiūrėtoju arba redaktoriumi
links unlock <_id | share URL> Įveda bendrinamo elemento slaptažodį, kad 30 minučių galėtumėte matyti ir redaguoti jo paskirtį
links activity <id> Kas ir kaip pakeitė elementą
links reset-link <id> Naujas bendrinimo URL; senasis linkdash.dev/s/ URL nustoja veikti
links stats <id> Apsilankymų, atsisiuntimų ir paleidimų sumos, taip pat pagal variantus, bei robotai (crawlers)
links export Išveda visas nuorodas CSV formatu (viena eilutė vienam variantui)
links import <file> Importuoja URL ir teksto eilutes iš CSV
links variants list <id> Nuorodos variantai
links variants add <id> --name <n> Prideda variantą
links variants update <id> <name> Pakeičia variantą
links variants remove <id> <name> Pašalina variantą
webhooks list Išvardija webhook galinius taškus (slaptasis raktas paslėptas)
webhooks get <id> Rodo vieno webhook URL (slaptasis raktas paslėptas)
webhooks create --url <https> Prideda HTTPS galinį tašką (slaptasis raktas rodomas vieną kartą)
webhooks rotate <id> Išduoda naują pasirašymo slaptąjį raktą
webhooks delete <id> Pašalina webhook
domains list Išvardija pasirinktinius domenų vardus
domains add <host> Prideda domeno vardą (planu Free – 1)
domains connect <host> Domain Connect taikymo URL arba null
domains verify <host> Patikrina DNS per Unkey
domains remove <host> Pašalina domeno vardą
-h, --help Pagalba (paprastas tekstas)
-v, --version Versija

Jei tas pats slug yra dviejuose savininko domenuose, nurodykite --domain.

Kūrimo ir atnaujinimo parinktys

Slug yra nuorodos id, o kai nuoroda vieša, ir jos viešas kelias. Pavadinimą matote tik jūs. Naujos nuorodos yra ribotos prieigos (žr. Prieiga ir bendrinimas). Kūrimo komanda priima lygiai vieną iš šių: --url, --file arba --text (tai tampa variantu main), --variant blokus (žr. Variantai) arba --folder <name> (žr. Aplankai).

Parinktis Pastabos
--url <url> Paskirties URL
--file <path> Įkeliamas failas (kuriant; atnaujinant pakeičia baitus)
--text <text> Teksto fragmentas
--access <restricted|link|public> Kas gali atidaryti. Numatytoji reikšmė restricted. Žr. Prieiga ir bendrinimas
--reset-share-link Išduoda naują bendrinimo URL (tik atnaujinant)
--slug <id> Viešas kelias: a-z0-9 ir vidiniai brūkšneliai, 1–64
--name <label> Privati etiketė
--tag <tag> Galima kartoti. Mažosios raidės, be kablelių. Daugiausia 20
--starts <when> Pradeda veikti po 7d, 24h, 30m arba nuo ISO datos
--password <secret> Atidarant reikalaujama šio slaptažodžio
--expires <when> Nustoja veikti po 7d, 24h, 30m arba nuo ISO datos
--max-openings <n> Sustabdoma po nurodyto atidarymų skaičiaus. Praleiskite, jei ribos nereikia
--domain <host> Pateikiama šiame domene vietoje lida.sh
--in <folder-id> Sukuriama šiame aplanke (tik kuriant; --in-domain <host>, jei aplanko slug kartojasi)
--status <active|paused> Sustabdo arba atnaujina veikimą (tik atnaujinant)
--sticky / --no-sticky Grįžtantis lankytojas gauna tą patį variantą (numatytai sticky)
--restart-split Iš naujo sumaišo pastovius priskyrimus (tik atnaujinant)
--forward-params / --no-forward-params Prie URL variantų prideda lankytojo užklausos eilutę (numatytai išjungta). Žr. Užklausos parametrų perdavimas
--variant <name> Pradeda varianto bloką (tik kuriant). Žr. Variantai
--weight <n> --when <key=v1,v2> Kiekvienam variantui atskirai. Žr. Variantai ir Užklausos parametrų taisyklės
--preview-name <text> Viešos peržiūros (unfurl) pavadinimas
--preview-description <text> Viešos peržiūros aprašymas
--preview-image <path> Viešos peržiūros paveikslėlis
--utm-source --utm-medium --utm-campaign --utm-term --utm-content Tik URL nuorodoms
--clear-password --clear-expires --clear-starts --clear-tags --clear-preview --clear-name --clear-max-openings Tik atnaujinant

--status priima tik active arba paused. Būseną „pasibaigusi“ (expired) nustato --expires. Būseną „suplanuota“ (scheduled) nustato --starts. Iki pradžios viešas adresas grąžina „nerasta“. Pasiekus --max-openings ribą, nuoroda sustabdoma; kad ji vėl veiktų, padidinkite skaičių arba naudokite --clear-max-openings. Jau panaudoti atidarymai lieka įskaičiuoti, kol pakeisite arba pašalinsite ribą.

lida.sh slug yra bendri visiems naudotojams. Jei žodis užimtas, pridėkite pasirinktinį domeną ir bandykite dar kartą su --domain. Nuoroda firminiame domene nėra kartu skelbiama lida.sh.

Sąrašo parinktys

Išveda vieną puslapį, {items, cursor}: --limit yra 1-100 (numatytai 50); perduokite --cursor su ankstesnio puslapio cursor reikšme, kol ji taps null. Puslapyje gali būti mažiau elementų nei --limit, kai filtras dalį jų praleidžia. --q ieško ištisų žodžių, paskutinį laikydama priešdėliu (laun randa example.com/launch), o rezultatus rikiuoja pagal aktualumą; --in išvardija vieno aplanko turinį, pirmiausia aplankus; kitu atveju rikiuojama nuo naujausių.

Parinktis Pastabos
--limit <n> Elementų skaičius puslapyje, 1-100 (numatytai 50)
--cursor <c> Ankstesnio puslapio cursor
--q <text> Ieško žodžių pavadinime, slug, variantų pavadinimuose ir paskirtyse, failų pavadinimuose, fragmentų tekste ir žymose
--tag <tag> Filtruoja pagal žymą
--kind <url|file|text|folder|group> Filtruoja pagal tipą (group = keli variantai)
--status <status> active, paused, expired, scheduled arba mixed
--in <folder-id|root> Tik tai, kas tiesiogiai yra šiame aplanke arba viršutiniame lygyje. Be šios parinkties išvardijama viskas

Variantai

Kiekviena nuoroda yra vieno ar kelių variantų konteineris. Variantas – tai turinys (URL, failas arba tekstas) kartu su savais apribojimais (--password, --starts, --expires, --max-openings), --weight ir pasirinktinėmis lankytojo sąlygomis (--when). Be --variant nuoroda turi vieną variantą, pavadintą main, ir kiekviena aukščiau nurodyta komanda yra jo santrumpa. Lankytojas gauna vieną variantą: variantai, kurių --when atitinka, sudaro atrankos rinkinį (jei neatitinka nė vienas, rinkinį sudaro besąlygiai variantai), tada atliekamas svertinis pasirinkimas. Esant pastoviam priskyrimui (numatytai), grįžtantis lankytojas gauna tą patį variantą. Nuorodos apribojimai turi pirmenybę prieš varianto apribojimus. Variantų pavadinimai: mažosios raidės, skaitmenys, vidiniai brūkšneliai, 1–40 simbolių, unikalūs nuorodos ribose. Daugiausia 20 variantų.

Nuorodos kind yra varianto tipas, kai variantas vienas, ir group, kai jų yra keli. Nuorodos status yra nuorodos apribojimo būsena, kai ji nustatyta (paused, scheduled, expired), kitu atveju – bendra variantų būsena, o jei tokios nėra – mixed. variantStatuses skaičiuoja {active, paused, expired, scheduled}.

Kūrimas su variantų blokais

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> pradeda varianto bloką. Po jo einančios parinktys priklauso tam variantui iki kito --variant: --url|--file|--text, --password, --starts, --expires, --max-openings, --weight <n>, --when <key=v1,v2> (galima kartoti), --utm-*. Nuorodos parinktys (--slug --name --tag --domain --preview-* --password --starts --expires --max-openings --sticky --no-sticky --forward-params) rašomos prieš pirmąjį --variant.

Variantų pokomandės

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> priima vieną iš --url, --file, --text, taip pat apribojimų parinktis, --weight, --when, --utm-*. variants update <id> <name> priima --name <new>, turinį, apribojimų parinktis, --status active|paused, --weight, --when, --clear-when, --clear-password, --clear-starts, --clear-expires, --clear-max-openings. Nuoroda visada turi bent vieną variantą.

--when raktai

Raktas JSON laukas Reikšmės
country countries ISO-2 kodai (DE, AT)
device devices mobile tablet desktop
os os windows macos android ios linux other
browser browsers edge chrome firefox safari other
language languages atitiktis pagal priešdėlį (de, en-us)
referrer referrerHosts domeno priesaga (twitter.com)

Turi atitikti kiekvienas nustatytas raktas. --when country=DE,AT --when device=mobile atitinka { "countries": ["DE","AT"], "devices": ["mobile"] }.

Užklausos parametrų taisyklės

--when taip pat priima param: taisykles, taikomas lankytojo užklausos eilutei (lida.sh/promo?src=newsletter). Raktuose skiriamos didžiosios ir mažosios raidės, reikšmės lyginamos tiksliai, vienam variantui – daugiausia 10 taisyklių. Kableliai skaido --when, todėl parametro reikšmėje negali būti kablelio; sąrašams naudokite |.

Sintaksė JSON op Atitinka, kai
param:KEY=VALUE equals reikšmė yra lygiai VALUE
param:KEY!=VALUE notEquals reikšmė skiriasi arba rakto nėra
param:KEY~=VALUE includes reikšmėje yra VALUE
param:KEY^=VALUE startsWith reikšmė prasideda VALUE
param:KEY$=VALUE endsWith reikšmė baigiasi VALUE
param:KEY=v1|v2 in reikšmė yra viena iš sąrašo
param:KEY? arba param:KEY exists raktas yra
param:!KEY missing rakto nėra
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 forma: "when": { "params": [{ "key": "src", "op": "equals", "value": "newsletter" }] } (operacijoms exists / missing laukas value praleidžiamas). Parametrų reikšmės tikrinamos atidarymo metu ir niekada nesaugomos analitikoje.

Užklausos parametrų perdavimas

--forward-params / --no-forward-params komandose links create ir links update (nuorodos lygmens nustatymas, numatytai išjungtas) prie URL variantų prideda visą lankytojo užklausos eilutę: lida.sh/promo?src=nl atidaro https://example.com/?src=nl. Lankytojo reikšmės perrašo išsaugotąsias, įskaitant --utm-*. Failų ir teksto variantai šio nustatymo nepaiso. Tai maršrutizavimas, o ne prieigos kontrolė: parametrų gali pridėti bet kas. Parametrų reikšmės analitikoje nesaugomos. links get šį nustatymą rodo kaip forwardParams.

Pastovumas ir skaidymo paleidimas iš naujo

links update <id> --sticky / --no-sticky nustato, ar grįžtantis lankytojas gauna tą patį variantą. links update <id> --restart-split iš naujo sumaišo pastovius priskyrimus. Turinio parinktys komandoje links update veikia tik nuorodoms su vienu variantu; kitu atveju naudokite links variants update <id> <name>.

Aplankai

Aplankas – tai nuoroda, kuri išvardija į ją įdėtus elementus. Kaip veikia viešas puslapis ir prieiga, žr. Aplankai.

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> nustato aplanko pavadinimą (ne --name) ir priima --slug, --domain, --password, --starts, --expires, --max-openings, --tag, --preview-* ir --in. Jos negalima derinti su --url, --file, --text ar --variant. links move išveda {id, folder}. links copy išlaiko prieigos lygį, bet kopija gauna naują bendrinimo URL; žmonės nekopijuojami. links delete, pritaikyta aplankui, perkelia jo elementus lygiu aukščiau; --with-contents juos taip pat ištrina. Komandų list, get ir create eilutėse yra folder (aplanko, kuriame yra elementas, slug arba null); aplankų eilutėse taip pat yra items.

Prieiga ir bendrinimas

Naujos nuorodos ir aplankai yra restricted: jų url yra https://linkdash.dev/s/<token>, kurį gali atidaryti tik jūs ir žmonės, su kuriais bendrinate, prisijungę prie paskyros. --access link atveria šį URL visiems, kurie jį turi. --access public pateikia nuorodą jos trumpuoju URL (lida.sh/<slug> arba jūsų pasirinktiniame domene). Nuorodoms, kurias skelbiate viešai, naudokite --access public. Slug visose komandose išlieka id, o jo trumpasis URL lieka rezervuotas, kol nuoroda nėra vieša. Visą modelį rasite skyriuje Bendrinimas ir prieiga.

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
Komanda Išveda
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 (be id) {items: [{id, name?, kind, access, url, people: [{email, accepted, invitedAt}]}], cursor}, pirmiausia vėliausiai bendrinti
links shared {items: [{_id, _creationTime, kind, title?, status, hasPassword, access, url, itemCount?, sharedBy?, sharedAt}], cursor}, nuo naujausių
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> (arba links update <id> --reset-share-link) {id, access, url}

--role editor suteikia asmeniui redaktoriaus teises: redaktorius gali keisti elementą ir matyti jo statistiką, bet negali matyti slaptažodžių, keisti slug, domeno, prieigos ar bendrinimo, negali ištrinti, perkelti ar kopijuoti, o slaptažodžiu apsaugotą paskirtį pirmiausia turi atrakinti su links unlock (30 minučių). Redaktoriai naudoja _id arba bendrinimo URL iš links shared. Kai slug kartojasi, visos komandos priima --domain <host>. url komandų create, get, list, update, copy ir share išvestyje yra bendrinimo URL, nebent nuoroda vieša – tada tai trumpasis URL; eilutėse yra access. Iki 200 žmonių vienam elementui, 50 el. pašto adresų vienam iškvietimui, 100 kvietimo laiškų vienai paskyrai per dieną. Abu sąrašai išveda po vieną puslapį: --limit yra 1-100 (numatytai 50); perduokite --cursor iš ankstesnio puslapio, kol cursor taps null. links leave priima _id arba url iš links shared; prieiga per aukščiau esantį bendrinamą aplanką išlieka. Bendrinimas, bendrinimo atšaukimas, prieigos pakeitimas ir nuorodos atstatymas kiekvienas skaičiuojami kaip vienas įvykis; pasitraukimas – ne.

Statistika

linkdash links stats <id> --last 24h

--last yra trukmė (24h, 7d). Numatytai 24h. JSON apima visits, downloads, plays, visitsInLast, countries, referrers, variants (sumos pagal variantus), visitors (kiekvienas su variant) ir crawlers ([{crawler, company, category, hits, lastSeen}]: robotai ir nuorodų peržiūros, kurie gavo nuorodą; jie niekada neskaičiuojami kaip apsilankymai).

CSV

Stulpeliai: slug,kind,name,variant,url,text,fileName,status,domain,tags,starts,expires,maxOpenings,weight,when,created,folder,access. Viena eilutė vienam variantui. kind, status, url, text, fileName, weight ir when (JSON eilutė) priklauso variantui; kiti stulpeliai priklauso nuorodai ir kartojasi. folder yra aplanko, kuriame yra nuoroda, slug. access yra restricted, link arba public. Slaptažodžiai, bendrinimo žetonai ir žmonės neįtraukiami.

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

Importuojant eilutės grupuojamos pagal slug + domeną. Pirmoji eilutė sukuria nuorodą su jos variantu; tolesnės eilutės prideda variantus. Esamai nuorodai pirmoji eilutė atnaujina nuorodos laukus, tada kiekviena eilutė atnaujina variantą pagal pavadinimą, jei jis egzistuoja, o kitu atveju jį prideda. Failų eilutės be baitų praleidžiamos, pateikiant klaidą tai eilutei. Eilutės, kuriose kind = folder (su name), sukuria aplankus; stulpelis folder įdeda kiekvieną nuorodą į jos aplanką, kai jau sukurtos visos eilutės. Tuščias access naujas nuorodas padaro ribotos prieigos, o esamų nuorodų nekeičia.

Pavyzdžiai

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

Taip pat žr. aplankai, bendrinimas ir prieiga, webhooks ir pasirinktiniai domenai.

Was this page helpful?