API REST
npm i -g @linktwin/cli
LinkTwin CLI: encurte e gerencie links pela linha de comando.
A CLI do LinkTwin leva links curtos e deep links para o seu terminal. Crie, edite e analise links, gerencie QR codes, coleções, domínios e pixels, e automatize tudo isso com comandos simples e saída em JSON. Feita para desenvolvedores, scripts e CI.
npm install -g @linktwin/cli
- Node.js 18 ou mais recente
- Licença MIT, no npm
- Programável com --json
Sessão de exemplo com comandos reais e formatos de saída.
Feito para desenvolvedores
Pare de trocar de contexto só para encurtar um link.
Você vive no terminal. Abrir um painel para criar um link, ou montar chamadas de API à mão para um script rápido, te atrasa. A CLI do LinkTwin coloca a criação de links, o deep linking e as análises a um comando de distância.
Passos até concluir
- Painel
- LinkTwin CLI
linktwin links create <url>
Começar
Funcionando com dois comandos
Requer o Node.js 18+. Sua chave de API é salva localmente em ~/.linktwin/config.json.
# 1. Instale (Node.js 18 ou mais recente)
npm install -g @linktwin/cli
# 2. Autentique (cole sua chave de API)
linktwin login
# 3. Crie seu primeiro link
linktwin links create https://example.com --custom hello
Usa IA? Experimente o servidor MCP. Está criando sua própria integração? Leia a documentação da API.
De onde vem sua chave de API
A CLI procura as credenciais nesta ordem e usa a primeira que encontrar, então um job de CI pode substituir seu login salvo sem alterá-lo.
- Flags
--api-key--base-url - Variáveis de ambiente
LINKTWIN_API_KEYLINKTWIN_BASE_URL - Login salvo~/.linktwin/config.json, gravado por linktwin login e legível só por você (modo 0600).
- URL base padrão
https://linktw.in
Comandos
Tudo, a partir de um único comando
Um comando focado para cada parte do seu fluxo de trabalho com links. Todo comando também aceita as opções globais --json, --api-key, --base-url.
linktwin links
Crie, liste, obtenha, atualize, exclua e exclua em massa links curtos e deep links.
-
linktwin links create <url>Criar um link curto ou deep link
- -c, --custom <alias>
- -p, --password
- -d, --domain
- --expiry
- --clicklimit
- --expiration-redirect
- --note
- --display-title
- --metatitle
- --metadescription
- --metaimage
- --collections
- --pixels
- --data <json>
-
linktwin links listListar seus links
- -l, --limit
- --page
- -o, --order
- -s, --search
- --from
- --to
- --collections
-
linktwin links get <id>Mostrar todos os detalhes de um link (ID ou URL curta)
- --timezone
-
linktwin links update <id>Atualizar um link (ID ou URL curta). Só os campos alterados são enviados.
- --url
- e todas as opções de criação
-
linktwin links delete <id>Excluir um link (ID ou URL curta)
- -y, --yes
-
linktwin links bulk-delete <ids>Excluir vários links por IDs separados por vírgula
- -y, --yes
$ linktwin links list --order clicks_desc --limit 3
ID Short URL Clicks Title Created
──── ───────────────────────────── ────── ──────────────────────────────── ───────────────────
1221 https://linktw.in/desk-tour 1764 My $200 desk setup (full tour) 2026-08-06 21:41:00
1222 https://linktw.in/new-camera 1098 Unboxing my new camera 2026-09-21 18:52:00
1224 https://linktw.in/my-keyboard 570 Amazon: Low profile mechanical … 2026-08-07 10:30:00
Page 1/3 · 9 total
linktwin stats
Análises por link e da conta: cliques, países, referenciadores, dispositivos e tendências.
-
linktwin stats link <id>Análises de um único link (ID ou URL curta)
- --timezone
-
linktwin stats dashboardKPIs agregados da conta e tendência de cliques
- -p, --period 1d|1w|1m|1y|max
- --timezone
-
linktwin stats detailedAnálises detalhadas da conta com segmentações
- -r, --range 1d|7d|30d|max|custom
- --start
- --end
- --collections
- --timezone
-
linktwin stats trendDistribuição de cliques por hora/dia (tendência diária)
- -p, --period
- --timezone
$ linktwin stats dashboard --period 1m
Dashboard
Total clicks: 4370
Unique clicks: 3915
Top country: United States
Top referrer: https://l.instagram.com
Total links: 9
Growth %: 64.22
linktwin collections
Organize links em coleções e atribua links em massa.
-
linktwin collections listListar coleções
- -l, --limit
- --page
-
linktwin collections get <id>Listar itens de uma coleção
- -l, --limit
- --page
-
linktwin collections create <name>Crie uma coleção
- --description
- --color <hex>
- --slug
- --public
- --starred
-
linktwin collections update <id>Atualizar uma coleção
- --name
- --description
- --color
- --public <bool>
- --starred <bool>
-
linktwin collections assign <collectionId> <linkIds>Adicionar/remover links em uma coleção (IDs de links separados por vírgula)
- --remove
-
linktwin collections delete <id>Excluir uma coleção (os itens são desvinculados, não excluídos)
- -y, --yes
$ linktwin collections assign 4 1221,1222,1223
✓ Added 3, removed 0 link(s).
linktwin domains
Adicione e gerencie seus domínios personalizados com marca.
-
linktwin domains listListar todos os domínios disponíveis (padrão + personalizados)
- -l, --limit
- --page
-
linktwin domains add <domain>Adicionar um domínio personalizado (inclua http:// ou https://)
- --redirect-root
- --redirect-404
-
linktwin domains update <id>Atualizar um domínio personalizado
- --redirect-root
- --redirect-404
-
linktwin domains delete <id>Excluir um domínio personalizado
- -y, --yes
$ linktwin domains add https://go.mayamakes.shop --redirect-root https://mayamakes.shop
✓ Added domain https://go.mayamakes.shop (id 12).
linktwin pixels
Crie pixels de retargeting e anexe-os a links.
-
linktwin pixels listListar pixels de retargeting
- -l, --limit
- --page
-
linktwin pixels get <id>Mostrar um pixel e os links vinculados
- -l, --limit
- --page
-
linktwin pixels createCriar um pixel de retargeting
- -t, --type fbpixel|gtmpixel|…
- -n, --name
- --tag
- --event
-
linktwin pixels update <id>Atualizar um pixel
- --tag
- -n, --name
- --event
-
linktwin pixels assign <pixelId> <linkIds>Adicionar/remover um pixel em links (IDs de links separados por vírgula)
- --remove
-
linktwin pixels delete <id>Excluir um pixel
- -y, --yes
$ linktwin pixels create --type fbpixel --name "Meta pixel" --tag 1234567890
✓ Created pixel Meta pixel (id 4).
linktwin qr
Gere e gerencie QR codes para qualquer link.
-
linktwin qr listListar Códigos QR
- -l, --limit
- --page
-
linktwin qr get <id>Mostrar um QR code e as análises de leitura
-
linktwin qr createCriar um QR code
- -t, --type text|vcard|link|email|phone|sms|wifi
- -d, --data
- --background
- --foreground
- --logo
-
linktwin qr update <id>Atualizar um QR code
- -d, --data
- --background
- --foreground
- --logo
-
linktwin qr delete <id>Excluir um QR code
- -y, --yes
$ linktwin qr create --type link --data https://linktw.in/desk-tour
✓ Created QR code https://linktw.in/qr/a58f79 (id 3).
Conta
Salve sua chave uma vez, confira qual conta você está usando e veja de onde vêm suas credenciais.
-
linktwin loginSalvar sua chave de API do LinkTwin e a URL base
- -k, --key
- -u, --url
- --no-verify
-
linktwin logoutRemover credenciais salvas
-
linktwin whoamiMostrar a conta atual, o plano e o uso
-
linktwin configMostrar de onde as credenciais são lidas
$ linktwin whoami
Account
Email: [email protected]
Plan: Large
User ID: 57842
Links used: 9
Clicks: 4370
Base URL: https://linktw.in
Feita para scripts, cron jobs e CI.
Os mesmos comandos funcionam em um script de shell, em uma tarefa agendada ou em um pipeline de build. Adicione --json para uma saída que você pode processar e passe sua chave como variável de ambiente.
- --json em qualquer comando imprime a resposta bruta da API, pronta para o jq.
- LINKTWIN_API_KEY e LINKTWIN_BASE_URL substituem o login salvo, então o CI nunca precisa de linktwin login.
- Comandos de exclusão não rodam sem --yes, então um script nunca remove links por acidente.
- Qualquer erro sai com código 1 e imprime o motivo no stderr, então uma etapa com falha interrompe seu pipeline.
# Seus 5 links mais clicados, com cliques e URL curta
linktwin links list --order clicks_desc --limit 5 --json \
| jq -r '.data.urls[] | "\(.clicks)\t\(.shorturl)"'
# Um link curto para cada URL em urls.txt
while read -r url; do
linktwin links create "$url" --json | jq -r '.shorturl'
done < urls.txt
# Geo segmentação e parâmetros UTM, passados como JSON
linktwin links create https://example.com --custom promo \
--data '{"geotarget":[{"location":"Canada","link":"https://example.ca"}],
"parameters":[{"name":"utm_source","value":"newsletter"}]}'
# Uma etapa do workflow: um link curto para cada release
- name: Short link for the release notes
env:
LINKTWIN_API_KEY: ${{ secrets.LINKTWIN_API_KEY }}
run: |
npm install -g @linktwin/cli
linktwin links create "https://example.com/releases/${{ github.ref_name }}" --json
Perguntas sobre a CLI
Tudo sobre a ferramenta de linha de comando do LinkTwin. Ainda tem dúvidas? Fale conosco.
O que é a CLI do LinkTwin?
A CLI do LinkTwin é uma ferramenta de linha de comando, o comando linktwin, para encurtar e gerenciar links pelo terminal. Você pode criar links curtos e deep links, gerenciar coleções, domínios personalizados, pixels de retargeting e QR codes, e obter análises de cliques sem abrir o painel. Todo comando suporta saída --json para scripts e automação.
Como instalo a CLI do LinkTwin?
Instale pelo npm com npm install -g @linktwin/cli. Ela precisa do Node.js 18 ou mais recente. Depois, execute linktwin login, cole sua chave de API e pronto: você já pode criar links pela linha de comando.
A CLI do encurtador de URL é gratuita?
A CLI em si é grátis e tem licença MIT. Ela funciona pela API do LinkTwin, e o acesso à API está disponível em todos os planos. Você pode criar uma conta grátis primeiro e fazer upgrade quando precisar da API.
Posso usar a CLI em scripts e em CI?
Sim. Passe --json para qualquer comando para obter uma saída legível por máquina que você pode enviar para o jq, e autentique sem prompt definindo a variável de ambiente LINKTWIN_API_KEY. Isso torna a CLI ideal para pipelines de build, cron jobs e criação de links em massa.
A CLI consegue criar deep links, não apenas links curtos?
Sim. Cada link que você cria abre no app certo do celular, como YouTube, Amazon ou Spotify. A CLI também define segmentação por país, dispositivo e idioma, teste A/B, parâmetros UTM e domínios personalizados. Passe a segmentação avançada como JSON com a flag --data.
Onde obtenho minha chave de API?
Entre no LinkTwin e abra Configurações, ou Ferramentas e Integrações e depois Ferramenta CLI, no seu painel. Copie sua chave de API e execute linktwin login, ou defina-a como a variável de ambiente LINKTWIN_API_KEY. A chave aparece quando seu plano inclui acesso à API.
Quais comandos a CLI do LinkTwin tem?
login, logout, whoami e config para suas credenciais, além de seis grupos de comandos: links, stats, collections, domains, pixels e qr. Execute linktwin seguido de qualquer comando e --help para ver todas as opções.
Como me refiro a um link em um comando?
Use o ID numérico ou a URL curta, por exemplo linktwin stats link linktw.in/desk-tour. A URL curta funciona com ou sem https://. Você encontra os dois na saída de linktwin links list.
Uma chave de API, três formas de desenvolver
A REST API, o servidor MCP e a CLI usam a mesma chave de API e gerenciam os mesmos links.
Servidor MCP
Deixe seu agente de IA criar os links
Ver o servidor MCPDocumentação da API
Todos os endpoints, com exemplos
Leia a documentação da APIEncurte seu próximo link sem sair do terminal
Instale a CLI do LinkTwin e comece a gerenciar links pelo seu shell.
npm install -g @linktwin/cli
O acesso à API está disponível em todos os planos. Ver planos