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

CLI

Paigalda linkdash-cli npm-ist ja käivita käsk `linkdash`. Õnnestunud käsud prindivad JSON-i stdout-i. Abi ja vead tulevad lihttekstina stderr-i.

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

npm-pakett on linkdash-cli. Käsk on linkdash.

HTTP vaste: HTTP API. MCP: MCP. Agendi oskus: Agendi oskus. Hinnad: Hinnad. Lihtne markdown: cli.md.

Lippu --json pole. Vigade korral on väljumiskood 1.

Autentimine

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

Kontot veel pole? auth create avab https://linkdash.dev/sign-up ja suunab sind seejärel CLI koodiga tagasi aadressile https://linkdash.dev/device, et saaksid kinnitada. Konto on juba olemas? auth login avab /device. Ilma brauserita: määra LINKDASH_TOKEN väärtuseks seansitoken, mille said käsuga auth create või auth login. Ära mõtle tokeneid ise välja.

Seansifail: ~/.config/linkdash/config.json (õigused 0600).

CLI ei saa muuta e-posti, parooli ega arveldust. Suuna kasutaja juhtpaneelile. API-võtmed (HTTP ja MCP): API-võtmed.

Käsud

linkdash <command> [options]
Käsk Mida see teeb
auth create Registreerimine brauseris, seejärel seadme kinnitamine
auth login Seadmega sisselogimine brauseris
auth logout Unusta salvestatud seanss
auth whoami Sisselogitud konto JSON-ina
links list Loetle lingid ja kaustad, üks lehekülg korraga (--limit, --cursor)
links get <id> Üks link
links create --url <url> Lühilink URL-ist
links create --file <path> Laadi fail üles ja saa link
links create --text <text> Salvesta tekstijupp
links create --folder <name> Loo kaust
links create --variant <name> … Link mitme variandiga (jaotus / sihtimine)
links update <id> Muuda sihtkohta, faili, parooli, aegumist, domeeni, olekut, sticky’t või edastatavaid parameetreid
links move <id> --in <folder-id> Pane link või kaust kausta (--root ülemise taseme jaoks)
links copy <id> Tee koopia uue slugiga samas kaustas
links delete <id> Kustuta link (kausta üksused liiguvad taseme võrra üles; --with-contents kustutab need)
links share <id> --email <email> Jaga inimestega e-posti teel (korda --email; --role editor lubab neil seda muuta; iga uus inimene saab kutsemeili)
links unshare <id> --email <email> Eemalda kellegi juurdepääs
links shares [id] Kes peale sinu saavad seda avada, kaasa arvatud ülemise kausta kaudu. Ilma id-ta: kõik, kuhu oled inimesi kutsunud, üks lehekülg korraga (--limit, --cursor)
links shared Mida teised on sinuga jaganud, üks lehekülg korraga (--limit, --cursor)
links leave <_id | share URL> Loobu millestki, mida sinuga jagati
links role <id> --email <e> --role viewer|editor Muuda kutsutud inimene vaatajaks või toimetajaks
links unlock <_id | share URL> Sisesta jagatud üksuse parool, et selle sihtkohta 30 minutit näha ja muuta
links activity <id> Kes üksust muutis ja kuidas
links reset-link <id> Uus jagamis-URL; vana linkdash.dev/s/ URL lakkab töötamast
links stats <id> Külastuste, allalaadimiste ja esituste koguarvud, ka variandi kaupa, lisaks roomikud
links export Prindi kõik lingid CSV-na (üks rida variandi kohta)
links import <file> Impordi URL- ja tekstiread CSV-st
links variants list <id> Lingi variandid
links variants add <id> --name <n> Lisa variant
links variants update <id> <name> Muuda varianti
links variants remove <id> <name> Eemalda variant
webhooks list Loetle veebihaagi lõpp-punktid (saladus maskitud)
webhooks get <id> Näita ühe veebihaagi URL-i (saladus maskitud)
webhooks create --url <https> Lisa HTTPS-lõpp-punkt (saladust näidatakse üks kord)
webhooks rotate <id> Väljasta uus allkirjastamise saladus
webhooks delete <id> Eemalda veebihaak
domains list Loetle kohandatud hostinimed
domains add <host> Lisa hostinimi (Free paketis 1)
domains connect <host> Domain Connecti rakendamise URL või null
domains verify <host> Kontrolli DNS-i Unkey abil
domains remove <host> Eemalda hostinimi
-h, --help Abi (lihttekst)
-v, --version Versioon

Kui sama slug on olemas omaniku kahel domeenil, lisa --domain.

Loomise ja muutmise lipud

Slug on lingi id ja avaliku lingi puhul ka selle avalik tee. Nimi on nähtav ainult sulle. Uued lingid on piiratud (vt Juurdepääs ja jagamine). Loomine võtab täpselt ühe järgmistest: --url, --file või --text (sellest saab variant main), --variant-plokid (vt Variandid) või --folder <name> (vt Kaustad).

Lipp Märkused
--url <url> Siht-URL
--file <path> Üleslaaditav fail (loomisel või muutmisel baitide asendamiseks)
--text <text> Tekstijupp
--access <restricted|link|public> Kes saab seda avada. Vaikimisi restricted. Vt Juurdepääs ja jagamine
--reset-share-link Väljasta uus jagamis-URL (ainult muutmisel)
--slug <id> Avalik tee: a-z0-9 ja sisemised sidekriipsud, 1–64
--name <label> Privaatne silt
--tag <tag> Korratav. Väiketähed, ilma komadeta. Kuni 20
--starts <when> Muutub aktiivseks pärast 7d, 24h, 30m või ISO-kuupäeval
--password <secret> Nõua avamiseks seda parooli
--expires <when> Lõpeta serveerimine pärast 7d, 24h, 30m või ISO-kuupäeval
--max-openings <n> Peata pärast nii mitut avamist. Jäta ära, kui piirangut ei soovi
--domain <host> Serveeri lida.sh asemel sellel hostil
--in <folder-id> Loo selle kausta sisse (ainult loomisel; --in-domain <host>, kui kausta slug kordub)
--status <active|paused> Peata või jätka (ainult muutmisel)
--sticky / --no-sticky Tagasipöörduv külastaja saab sama variandi (vaikimisi sticky)
--restart-split Sega sticky-määrangud uuesti (ainult muutmisel)
--forward-params / --no-forward-params Lisa külastaja päringustring URL-variantidele (vaikimisi väljas). Vt Päringuparameetrite edastamine
--variant <name> Alusta variandiplokki (ainult loomisel). Vt Variandid
--weight <n> --when <key=v1,v2> Variandi kaupa. Vt Variandid ja Päringuparameetrite reeglid
--preview-name <text> Avaliku eelvaate nimi
--preview-description <text> Avaliku eelvaate kirjeldus
--preview-image <path> Avaliku eelvaate pilt
--utm-source --utm-medium --utm-campaign --utm-term --utm-content Ainult URL-lingid
--clear-password --clear-expires --clear-starts --clear-tags --clear-preview --clear-name --clear-max-openings Ainult muutmisel

--status aktsepteerib ainult väärtusi active või paused. Aegunud olek tuleb lipust --expires. Ajastatud olek tuleb lipust --starts. Avalik lahendamine annab kuni alguseni tulemuse not-found. Kui --max-openings täitub, link peatub; selle uuesti serveerimiseks suurenda arvu või kasuta --clear-max-openings. Juba kasutatud avamised jäävad arvesse, kuni muudad või eemaldad piirangu.

lida.sh slugid on ühised. Kui sõna on võetud, lisa kohandatud domeen ja proovi uuesti koos --domain-iga. Brändidomeeni link ei avaldu lisaks lida.sh-is.

Loetlemise lipud

Prindib ühe lehekülje, {items, cursor}: --limit on 1-100 (vaikimisi 50); anna --cursor-ile eelmise lehekülje cursor, kuni see on null. Leheküljel võib olla vähem üksusi kui --limit, kui filter mõned vahele jätab. --q leiab terveid sõnu, viimast neist eesliitena (laun leiab example.com/launch), järjestatuna asjakohasuse järgi; --in loetleb ühe kausta, kaustad eespool; muidu uuemad eespool.

Lipp Märkused
--limit <n> Üksusi lehekülje kohta, 1-100 (vaikimisi 50)
--cursor <c> Eelmise lehekülje cursor
--q <text> Otsi sõnu nimest, slugist, variantide nimedest ja sihtkohtadest, failinimedest, tekstijuppidest ja siltidest
--tag <tag> Filtreeri sildi järgi
--kind <url|file|text|folder|group> Filtreeri tüübi järgi (group = mitu varianti)
--status <status> active, paused, expired, scheduled või mixed
--in <folder-id|root> Ainult see, mis on otse selles kaustas või ülemisel tasemel. Ilma selleta loetletakse kõik

Variandid

Iga link on konteiner ühele või mitmele variandile. Variant on sisu (URL, fail või tekst) koos oma väravaga (--password, --starts, --expires, --max-openings), kaaluga --weight ja valikuliste külastajatingimustega (--when). Ilma --variant-ita on lingil üks variant nimega main ja kõik ülaltoodud käsud on selle lühivormid. Külastaja saab ühe variandi: variandid, mille --when sobib, moodustavad valimi (kui ükski ei sobi, moodustavad selle tingimusteta variandid), seejärel tehakse kaalutud valik. Sticky-määranguga (vaikimisi) saab tagasipöörduv külastaja sama variandi. Lingi enda värav on variantide väravatest tähtsam. Variandinimed: väiketähed, numbrid, sisemised sidekriipsud, 1–40 märki, lingi piires unikaalsed. Kuni 20 varianti.

Lingi kind on ühe variandi puhul selle variandi tüüp ja mitme puhul group. Lingi status on lingi värava olek, kui see on määratud (paused, scheduled, expired), muidu variantide ühine olek, muidu mixed. variantStatuses loendab {active, paused, expired, scheduled}.

Loomine variandiplokkidega

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> alustab variandiplokki. Sellele järgnevad lipud kuuluvad selle variandi juurde kuni järgmise --variant-ini: --url|--file|--text, --password, --starts, --expires, --max-openings, --weight <n>, --when <key=v1,v2> (korratav), --utm-*. Lingi lipud (--slug --name --tag --domain --preview-* --password --starts --expires --max-openings --sticky --no-sticky --forward-params) tulevad enne esimest --variant-it.

Variantide alamkäsud

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> võtab ühe lippudest --url, --file, --text, lisaks väravalipud, --weight, --when, --utm-*. variants update <id> <name> võtab --name <new>, sisu, väravalipud, --status active|paused, --weight, --when, --clear-when, --clear-password, --clear-starts, --clear-expires, --clear-max-openings. Lingile jääb alati vähemalt üks variant.

--when võtmed

Võti JSON-väli Väärtused
country countries ISO-2 koodid (DE, AT)
device devices mobile tablet desktop
os os windows macos android ios linux other
browser browsers edge chrome firefox safari other
language languages eesliite vaste (de, en-us)
referrer referrerHosts hosti järelliide (twitter.com)

Iga määratud võti peab sobima. --when country=DE,AT --when device=mobile on { "countries": ["DE","AT"], "devices": ["mobile"] }.

Päringuparameetrite reeglid

--when võtab ka param:-reegleid külastaja päringustringi kohta (lida.sh/promo?src=newsletter). Võtmed on tõstutundlikud, väärtusi võrreldakse täpselt, kuni 10 reeglit variandi kohta. Komad jagavad --when-i osadeks, seega parameetri väärtus ei tohi koma sisaldada; loendite jaoks kasuta |.

Süntaks JSON op Sobib, kui
param:KEY=VALUE equals väärtus on täpselt VALUE
param:KEY!=VALUE notEquals väärtus erineb või võti puudub
param:KEY~=VALUE includes väärtus sisaldab VALUE
param:KEY^=VALUE startsWith väärtus algab VALUE-ga
param:KEY$=VALUE endsWith väärtus lõpeb VALUE-ga
param:KEY=v1|v2 in väärtus on üks loendis olevatest
param:KEY? või param:KEY exists võti on olemas
param:!KEY missing võti puudub
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-kuju: "when": { "params": [{ "key": "src", "op": "equals", "value": "newsletter" }] } (exists / missing puhul jäetakse value ära). Parameetrite väärtusi võrreldakse avamise hetkel ja neid ei salvestata kunagi analüütikasse.

Päringuparameetrite edastamine

--forward-params / --no-forward-params käskudes links create ja links update (lingi tasemel, vaikimisi väljas) lisab külastaja kogu päringustringi URL-variantidele: lida.sh/promo?src=nl avab https://example.com/?src=nl. Külastaja väärtused kirjutavad salvestatud väärtused üle, ka --utm-*. Faili- ja tekstivariandid eiravad seda. See on suunamine, mitte juurdepääsukontroll: igaüks saab parameetreid lisada. Parameetrite väärtusi ei salvestata analüütikasse. links get näitab seda väljana forwardParams.

Sticky ja jaotuse taaskäivitamine

links update <id> --sticky / --no-sticky määrab, kas tagasipöörduv külastaja saab sama variandi. links update <id> --restart-split segab sticky-määrangud uuesti. links update sisulipud töötavad ainult ühe variandiga linkide puhul; muul juhul kasuta käsku links variants update <id> <name>.

Kaustad

Kaust on link, mis loetleb sinna pandud üksused. Kuidas avalik leht ja juurdepääs töötavad, vaata lehelt Kaustad.

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> määrab kausta nime (mitte --name) ja võtab lipud --slug, --domain, --password, --starts, --expires, --max-openings, --tag, --preview-* ja --in. Seda ei saa kombineerida lippudega --url, --file, --text ega --variant. links move prindib {id, folder}. links copy säilitab juurdepääsutaseme, kuid saab uue jagamis-URL-i; inimesi ei kopeerita. links delete liigutab kausta puhul selle üksused taseme võrra üles; --with-contents kustutab ka need. Loetlemise, pärimise ja loomise read sisaldavad välja folder (sisaldava kausta slug või null); kaustaread sisaldavad ka välja items.

Juurdepääs ja jagamine

Uued lingid ja kaustad on restricted: nende url on https://linkdash.dev/s/<token>, mida saavad sisselogituna avada ainult sina ja inimesed, kellega jagad. --access link avab selle URL-i kõigile, kellel see on. --access public serveerib linki selle lühi-URL-il (lida.sh/<slug> või sinu kohandatud domeen). Kasuta --access public linkide puhul, mida postitad avalikult. Slug jääb kõigi käskude jaoks id-ks ja selle lühi-URL jääb reserveerituks, kuni link pole avalik. Täielikku mudelit vaata lehelt Jagamine ja juurdepääs.

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
Käsk Prindib
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 (ilma id-ta) {items: [{id, name?, kind, access, url, people: [{email, accepted, invitedAt}]}], cursor}, viimati jagatud eespool
links shared {items: [{_id, _creationTime, kind, title?, status, hasPassword, access, url, itemCount?, sharedBy?, sharedAt}], cursor}, uuemad eespool
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> (või links update <id> --reset-share-link) {id, access, url}

--role editor teeb kellestki toimetaja: ta saab üksust muuta ja selle statistikat näha, kuid ei saa muuta paroole, slugi, domeeni, juurdepääsu ega jagamist ega üksust kustutada, liigutada või kopeerida, ning parooliga kaitstud sihtkoht vajab enne käsku links unlock (30 minutiks). Toimetajad kasutavad links shared väljundist saadud _id-d või jagamis-URL-i. Kõik võtavad --domain <host>, kui slug kordub. url käskude create, get, list, update, copy ja share väljundis on jagamis-URL, välja arvatud juhul, kui link on avalik – siis on see lühi-URL; read sisaldavad välja access. Kuni 200 inimest üksuse kohta, 50 e-posti aadressi päringu kohta, 100 kutsemeili konto kohta päevas. Mõlemad loendid prindivad ühe lehekülje: --limit on 1-100 (vaikimisi 50); anna --cursor eelmiselt leheküljelt, kuni cursor on null. links leave võtab links shared väljundist _id või url; juurdepääs ülemise jagatud kausta kaudu jääb alles. Jagamine, jagamise lõpetamine, juurdepääsu muutmine ja lähtestamine loevad igaüks ühe sündmusena; lahkumine mitte.

Statistika

linkdash links stats <id> --last 24h

--last on kestus (24h, 7d). Vaikimisi 24h. JSON sisaldab välju visits, downloads, plays, visitsInLast, countries, referrers, variants (koguarvud variandi kaupa), visitors (igaühel variant) ja crawlers ([{crawler, company, category, hits, lastSeen}]: robotid ja lingieelvaated, mis linki laadisid; neid ei loeta kunagi külastusteks).

CSV

Veerud: slug,kind,name,variant,url,text,fileName,status,domain,tags,starts,expires,maxOpenings,weight,when,created,folder,access. Üks rida variandi kohta. kind, status, url, text, fileName, weight ja when (JSON-string) on variandipõhised; ülejäänud on lingipõhised ja korduvad. folder on selle kausta slug, milles link asub. access on restricted, link või public. Paroole, jagamistokeneid ega inimesi ei ekspordita.

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

Import rühmitab read slugi + domeeni järgi. Esimene rida loob lingi koos selle variandiga; järgmised read lisavad variante. Olemasoleva lingi puhul uuendab esimene rida lingi välju, seejärel uuendab iga rida varianti nime järgi, kui see on olemas, muidu lisab selle. Baitideta failiread jäetakse vahele ja nende kohta antakse reapõhine viga. Read, kus kind = folder (koos väärtusega name), loovad kaustad; veerg folder paigutab iga lingi selle kausta pärast seda, kui kõik read on olemas. Tühi access teeb uued lingid piiratuks ja jätab olemasolevad lingid muutmata.

Näited

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

Vaata ka: kaustad, jagamine ja juurdepääs, veebihaagid ja kohandatud domeenid.

Was this page helpful?