Commands
A complete reference of every command and flag. Run lnkify <command> --help at any time for the same information in your terminal.
Global flags
These work with any command and in any position (lnkify links list --json works just like lnkify --json links list):
| Flag | Description |
|---|---|
--json | Machine-readable JSON output on stdout |
--profile <name> | Config profile to use |
--url <url> | API base URL (overrides config/env) |
--api-key <key> | API key (overrides config/env) |
--no-color | Disable colored output |
--verbose | Verbose diagnostics on stderr |
-v, --version | Print the version |
-h, --help | Show help |
Auth
bash
lnkify login [--email <email>] [--password <password>] # prompts if omitted
lnkify logout # clear stored token
lnkify whoami # show current userSee Authentication for details.
Config
bash
lnkify config set <key> <value> # key: url | api-key | email | default-profile
lnkify config get <key>
lnkify config list # effective config + the source of each valueconfig set writes to the active profile (or default-profile globally).
Links
Create
bash
lnkify links create <target> [options]| Option | Description |
|---|---|
--slug <slug> | Custom slug (random if omitted) |
--title <title> | Human-friendly title |
--track / --no-track | Enable/disable click tracking |
--domain <domainId> | Attach to a custom domain by id |
--rule <rule> | Routing rule type=...,value=...,target=... (repeatable) |
bash
lnkify links create https://example.com --slug launch --title "Launch" --trackList
bash
lnkify links list [--search <q>] [--take <n>] [--skip <n>] [--page <n>]Get, update, delete
bash
lnkify links get <id>
lnkify links update <id> [--target <url>] [--title <t>] [--track|--no-track] [--rule ...]
lnkify links delete <id...> [--yes] # accepts multiple ids; --yes skips confirmBulk
Create, update, or delete many links from a .json or .csv file:
bash
lnkify links bulk create --file links.json [--dry-run]
lnkify links bulk update --file updates.csv
lnkify links bulk delete --file ids.json [--yes]--dry-runvalidates and previews without sending.- The CLI prints a per-row result table (
#,OK,slug/id,error).
See Examples for file formats.
Resolve
Resolve a slug to its destination URL:
bash
lnkify resolve <slug> [--hostname <host>]Use --hostname to resolve a link on a verified custom domain.
Analytics
Aggregate totals plus your top links:
bash
lnkify analyticsDomains
bash
lnkify domains add <hostname> # prints the DNS TXT record to set
lnkify domains list
lnkify domains verify <id> # verify after the TXT record is live
lnkify domains rm <id> [--yes]See the Custom Domains guide for the full DNS flow.
API keys
bash
lnkify apikeys create <label> [--expires <iso>] # secret shown once
lnkify apikeys list
lnkify apikeys revoke <id> [--yes]MCP
bash
lnkify mcp serve # run as a stdio MCP server for AI agents
lnkify mcp install [--client claude] [--write]See CLI + MCP.
Next: CLI + MCP