コンテンツにスキップ
LinkdashLinkdash
日本語
Esc
↑↓移動↵開く⌘Jプレビュー
このページの内容

CLI

npm から linkdash-cli をインストールし、`linkdash` コマンドを実行します。成功したコマンドは stdout に JSON を出力します。ヘルプとエラーは stderr にプレーンテキストで出力されます。

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。MCP: MCP。エージェントスキル: エージェントスキル。料金: 料金。プレーンな Markdown 版: cli.md。

--json フラグはありません。エラー時は終了コード 1 を返します。

認証

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

アカウントをまだお持ちでない場合は、auth create を実行すると https://linkdash.dev/sign-up が開きます。サインアップ後は CLI コードが入った状態で https://linkdash.dev/device に戻るので、そこで承認してください。すでにアカウントをお持ちの場合は、auth login を実行すると /device が開きます。ヘッドレス環境では、auth create または auth login で取得したセッショントークンを LINKDASH_TOKEN に設定してください。トークンを自分で作り出さないでください。

セッションファイル: ~/.config/linkdash/config.json(モード 0600)。

CLI ではメールアドレス、パスワード、請求情報を変更できません。これらの変更はユーザーにダッシュボードで行ってもらってください。API キー(HTTP および MCP 用): API キー。

コマンド

linkdash <command> [options]
コマンド 内容
auth create ブラウザでサインアップし、続けてデバイスを承認
auth login ブラウザでデバイスログイン
auth logout 保存されたセッションを削除
auth whoami サインイン中のアカウント情報を JSON で表示
links list リンクとフォルダーを 1 ページずつ一覧表示(--limit、--cursor)
links get <id> リンクを 1 件取得
links create --url <url> URL から短縮リンクを作成
links create --file <path> ファイルをアップロードしてリンクを作成
links create --text <text> スニペットを保存
links create --folder <name> フォルダーを作成
links create --variant <name> … 複数のバリアントを持つリンクを作成(分割 / ターゲティング)
links update <id> 遷移先、ファイル、パスワード、有効期限、ドメイン、ステータス、スティッキー、パラメーター転送を変更
links move <id> --in <folder-id> リンクまたはフォルダーをフォルダーに移動(トップレベルに移動するには --root)
links copy <id> 新しいスラッグでコピーを同じフォルダー内に作成
links delete <id> リンクを削除(フォルダーの場合、中のアイテムは 1 つ上の階層に移動します。--with-contents を付けると中のアイテムも削除)
links share <id> --email <email> メールアドレスを指定して共有(--email は繰り返し指定可能。--role editor を付けると相手も変更可能。新しく追加された人には招待メールが届きます)
links unshare <id> --email <email> 相手のアクセス権を削除
links shares [id] 自分以外に誰が開けるかを表示(上位フォルダー経由のアクセスも含む)。id を省略した場合は、自分が人を招待したすべてのアイテムを 1 ページずつ表示(--limit、--cursor)
links shared 他の人から共有されたものを 1 ページずつ表示(--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 を発行。古い linkdash.dev/s/ URL は使えなくなります
links stats <id> 訪問数、ダウンロード数、再生数の合計(バリアント別を含む)とクローラーの情報を表示
links export すべてのリンクを CSV で出力(バリアントごとに 1 行)
links import <file> CSV から URL とテキストの行をインポート
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> Webhook URL を 1 件表示(シークレットはマスク表示)
webhooks create --url <https> HTTPS エンドポイントを追加(シークレットは一度だけ表示)
webhooks rotate <id> 新しい署名シークレットを発行
webhooks delete <id> Webhook を削除
domains list カスタムホスト名を一覧表示
domains add <host> ホスト名を追加(Free プランでは 1 つまで)
domains connect <host> Domain Connect の適用 URL を表示(ない場合は null)
domains verify <host> Unkey で DNS を確認
domains remove <host> ホスト名を削除
-h, --help ヘルプ(プレーンテキスト)
-v, --version バージョン

所有者の 2 つのドメインに同じスラッグがある場合は、--domain を指定してください。

作成・更新時のフラグ

スラッグはリンクの ID で、リンクが公開されている場合は公開パスにもなります。名前は自分にしか表示されません。新しいリンクは制限付き(restricted)で作成されます(アクセスと共有を参照)。作成時には次のうちちょうど 1 つを指定します: --url、--file、--text のいずれか(これがバリアント main になります)、--variant ブロック(バリアントを参照)、または --folder <name>(フォルダーを参照)。

フラグ 備考
--url <url> 遷移先 URL
--file <path> アップロードするファイル(作成時。更新時はファイルの中身を置き換え)
--text <text> スニペット
--access <restricted|link|public> 誰が開けるか。デフォルトは restricted。アクセスと共有を参照
--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> を指定)
--status <active|paused> 一時停止または再開(更新時のみ)
--sticky / --no-sticky 再訪問者に同じバリアントを表示し続けるかどうか(デフォルトはスティッキー)
--restart-split スティッキーな割り当てを振り直す(更新時のみ)
--forward-params / --no-forward-params 訪問者のクエリ文字列を URL バリアントに付加(デフォルトはオフ)。クエリパラメーターの転送を参照
--variant <name> バリアントブロックを開始(作成時のみ)。バリアントを参照
--weight <n> --when <key=v1,v2> バリアントごとに指定。バリアントとクエリパラメーターのルールを参照
--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 更新時のみ

--status に指定できるのは active または paused のみです。期限切れ(expired)は --expires で、予約(scheduled)は --starts で決まります。開始日時になるまでは、公開 URL にアクセスしても not-found になります。--max-openings に達するとリンクは一時停止します。再び配信するには、回数を増やすか、--clear-max-openings を指定してください。使用済みの開封回数は、上限を変更または削除するまでカウントされたままです。

lida.sh のスラッグは全ユーザーで共有されています。使いたい語がすでに使われている場合は、カスタムドメインを追加してから --domain を付けて再度実行してください。独自ドメインのリンクは lida.sh では公開されません。

一覧表示のフラグ

1 ページ分を {items, cursor} の形式で出力します。--limit は 1〜100(デフォルト 50)です。前のページの cursor を --cursor に渡し、cursor が null になるまで繰り返してください。フィルターで除外されたアイテムがある場合、1 ページのアイテム数が --limit より少なくなることがあります。--q は単語単位で一致し、最後の単語だけは前方一致になります(laun で example.com/launch が見つかります)。結果は関連度順に並びます。--in を指定すると 1 つのフォルダーの中身をフォルダーを先にして表示します。どちらも指定しない場合は新しい順に並びます。

フラグ 備考
--limit <n> 1 ページあたりのアイテム数。1〜100(デフォルト 50)
--cursor <c> 前のページの cursor
--q <text> 名前、スラッグ、バリアント名と遷移先、ファイル名、スニペットのテキスト、タグに含まれる単語を検索
--tag <tag> タグで絞り込み
--kind <url|file|text|folder|group> 種類で絞り込み(group = 複数のバリアントを持つリンク)
--status <status> active、paused、expired、scheduled、mixed のいずれか
--in <folder-id|root> このフォルダーの直下、またはトップレベルにあるものだけを表示。指定しない場合はすべてを表示

バリアント

すべてのリンクは、1 つ以上のバリアントを入れるコンテナーです。バリアントは、コンテンツ(URL、ファイル、テキストのいずれか)、独自のゲート(--password、--starts、--expires、--max-openings)、--weight、および任意の訪問者条件(--when)で構成されます。--variant を指定しない場合、リンクには main という名前のバリアントが 1 つだけ作られ、上記のコマンドはすべてそのバリアントを操作する省略形として機能します。訪問者には 1 つのバリアントが割り当てられます。まず --when が一致するバリアントが候補になり(一致するものがなければ、条件のないバリアントが候補になります)、その中から重みに応じて 1 つが選ばれます。スティッキー割り当て(デフォルト)が有効な場合、再訪問者には同じバリアントが表示され続けます。リンク自体のゲートは、バリアントのゲートより優先されます。バリアント名には小文字、数字、先頭・末尾以外のハイフンを使用でき、1〜40 文字で、リンク内で一意である必要があります。バリアントは最大 20 個です。

リンクの kind は、バリアントが 1 つの場合はそのバリアントの種類、複数の場合は group になります。リンクの status は、リンクのゲート(paused、scheduled、expired)が設定されていればその値になります。設定されていなければ全バリアントに共通するステータスが使われ、共通でない場合は mixed になります。variantStatuses には {active, paused, expired, scheduled} ごとの件数が入ります。

バリアントブロックを使った作成

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 より前に置いてください。

バリアントのサブコマンド

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 のいずれか 1 つを指定します。あわせて、ゲート用のフラグ、--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 を指定できます。リンクには常に 1 つ以上のバリアントが必要です。

--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 では、訪問者のクエリ文字列(lida.sh/promo?src=newsletter)に対する param: ルールも指定できます。キーは大文字と小文字を区別し、値は完全一致で比較されます。ルールはバリアントごとに最大 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? または param:KEY exists キーが存在する
param:!KEY missing キーが存在しない
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" }] }(exists / missing の場合、value は省略されます)。パラメーターの値はリンクが開かれた時点で照合され、アナリティクスには保存されません。

クエリパラメーターの転送

links create と links update の --forward-params / --no-forward-params(リンク単位の設定で、デフォルトはオフ)を使うと、訪問者のクエリ文字列全体が 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 のコンテンツ用フラグは、バリアントが 1 つだけのリンクでのみ使用できます。複数ある場合は links variants update <id> <name> を使用してください。

フォルダー

フォルダーは、中に入れたアイテムを一覧表示するリンクです。公開ページとアクセスの仕組みについては、フォルダーを参照してください。

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 を実行すると、中のアイテムは 1 つ上の階層に移動します。--with-contents を付けると、中のアイテムも削除されます。list、get、create の出力の各行には folder(そのアイテムが入っているフォルダーのスラッグ、または null)が含まれます。フォルダーの行には items も含まれます。

アクセスと共有

新しいリンクとフォルダーは restricted で作成されます。その url は https://linkdash.dev/s/<token> で、サインインした自分と共有相手だけが開けます。--access link を指定すると、その URL を知っている人なら誰でも開けるようになります。--access public を指定すると、リンクは短縮 URL(lida.sh/<slug> またはカスタムドメイン)で配信されます。一般に公開する場所に投稿するリンクには --access public を使用してください。スラッグはどのコマンドでも引き続き ID として使われます。リンクが公開されていない間も、その短縮 URL は予約されたままです。全体の仕組みについては共有とアクセスを参照してください。

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 を指定すると、相手は編集者になります。編集者はアイテムの変更や統計の表示ができますが、パスワード、スラッグ、ドメイン、アクセス、共有の変更と、削除、移動、コピーはできません。また、パスワードで保護された遷移先を扱うには、先に links unlock を実行する必要があります(30 分間有効)。編集者は、links shared で得られる _id または共有 URL を使って操作します。スラッグが重複する場合は、どのコマンドでも --domain <host> を指定できます。create、get、list、update、copy、share の出力に含まれる url は、リンクが公開されていれば短縮 URL、そうでなければ共有 URL です。各行には access も含まれます。上限は、1 アイテムあたり 200 人、1 回の呼び出しあたり 50 件のメールアドレス、1 アカウントあたり 1 日 100 件の招待メールです。2 つの一覧コマンドは 1 ページ分を出力します。--limit は 1〜100(デフォルト 50)です。前のページの cursor を --cursor に渡し、cursor が null になるまで繰り返してください。links leave には、links shared で得られる _id または url を指定します。抜けた後も、上位の共有フォルダー経由のアクセスは残ります。共有、共有解除、アクセスの変更、リセットはそれぞれ 1 イベントとしてカウントされます。共有から抜ける操作はカウントされません。

統計

linkdash links stats <id> --last 24h

--last には期間(24h、7d)を指定します。デフォルトは 24h です。JSON には visits、downloads、plays、visitsInLast、countries、referrers、variants(バリアントごとの合計)、visitors(各要素に variant を含む)、crawlers が含まれます。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。バリアントごとに 1 行です。kind、status、url、text、fileName、weight、when(JSON 文字列)はバリアントごとの値です。それ以外の列はリンクごとの値なので、同じリンクの各行で繰り返されます。folder は、リンクが入っているフォルダーのスラッグです。access は restricted、link、public のいずれかです。パスワード、共有トークン、共有相手は出力に含まれません。

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

インポート時は、スラッグとドメインの組み合わせで行がグループ化されます。最初の行でリンクとそのバリアントが作成され、2 行目以降でバリアントが追加されます。既存のリンクの場合は、最初の行でリンクのフィールドを更新します。その後、各行について同名のバリアントがあれば更新し、なければ追加します。ファイルの中身が含まれていないファイル行はスキップされ、その行のエラーとして報告されます。kind が folder の行(name を含むもの)からはフォルダーが作成されます。folder 列の値は、すべての行が作成された後に、各リンクを該当するフォルダーに配置するために使われます。access が空の場合、新しいリンクは制限付きで作成され、既存のリンクはそのまま変更されません。

例

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

フォルダー、共有とアクセス、Webhook、カスタムドメインもあわせて参照してください。

このページは役に立ちましたか?