> ## Documentation Index
> Fetch the complete documentation index at: https://docs.so-me.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Links na bio

> Crie e gerencie páginas de link na bio com botões, galeria, temas e análises

Os links na bio (biolinks) são páginas públicas de destino do tipo link-in-bio. Cada página tem um slug personalizado, um nome de exibição e uma bio,
um tema (predefinido ou com cores personalizadas), uma lista de botões (link, rede social, e-mail, telefone, arquivo, texto), uma
grade de posts/galeria e análises de visualizações/cliques. Esta página documenta todos os comandos `biolink:` expostos pela
CLI.

> [!NOTE]
>
> Todos os comandos aceitam as [flags globais](/pt-BR/cli/overview.md#opções-globais): `--json` (padrão) / `--table`
> para o formato de saída, `--verbose` para erros detalhados e `--api-key <key>` / `--api-url <url>` para
> substituir as credenciais em cada chamada. Nenhum dos comandos `biolink:` aceita flags de paginação.

## Principais

### biolink:list

Lista todas as páginas de biolink da organização autenticada.

```bash theme={null}
so-me biolink:list
```

```bash Exemplo theme={null}
so-me biolink:list --table
```

### biolink:get

Obtém todos os detalhes de um único biolink pelo ID interno.

```bash theme={null}
so-me biolink:get <id>
```

```bash Exemplo theme={null}
so-me biolink:get 550e8400-e29b-41d4-a716-446655440000
```

### biolink:public

Exibe os dados públicos de um biolink usando o slug personalizado. Este comando resolve a página da mesma forma que um
visitante, portanto não exige o UUID interno.

```bash theme={null}
so-me biolink:public <slug>
```

```bash Exemplo theme={null}
so-me biolink:public my-brand-page
```

### biolink:create

Cria uma nova página de biolink. Todas as opções são opcionais.

```bash theme={null}
so-me biolink:create [options]
```

| Opção | Descrição |
| - | - |
| `--slug <slug>` | Slug personalizado da URL (3 a 50 caracteres alfanuméricos) |
| `--name <name>` | Nome de exibição |
| `--bio <bio>` | Texto da bio |

```bash Exemplo theme={null}
so-me biolink:create --slug mypage --name "My Brand" --bio "Welcome to my page"
```

### biolink:update

Atualiza uma página de biolink. Informe pelo menos uma opção, ou o comando termina com erro.

```bash theme={null}
so-me biolink:update <id> [options]
```

| Opção | Descrição |
| - | - |
| `--name <name>` | Nome de exibição |
| `--bio <bio>` | Texto da bio |
| `--slug <slug>` | Slug personalizado |
| `--button-style <style>` | Estilo dos botões: `rounded`, `square`, `pill`, `outline` |
| `--show-grid` | Mostra a grade do Instagram |
| `--hide-grid` | Oculta a grade do Instagram |
| `--social-icons <json>` | Ícones de redes sociais como um array JSON de objetos `{platform, url}` |

> [!NOTE]
>
> `--social-icons` deve ser um array JSON válido; um JSON inválido termina com erro antes de qualquer requisição ser
> feita. `--show-grid` e `--hide-grid` definem a visibilidade da grade do Instagram (passe uma, não as duas).

```bash Exemplos theme={null}
# Renomear e reescrever a bio
so-me biolink:update 550e8400-... --name "Acme Inc." --bio "Tools for makers"

# Trocar o estilo dos botões e mostrar a grade do Instagram
so-me biolink:update 550e8400-... --button-style pill --show-grid

# Definir os ícones de redes sociais (escape o JSON para o seu shell)
so-me biolink:update 550e8400-... \
  --social-icons '[{"platform":"instagram","url":"https://instagram.com/acme"},{"platform":"x","url":"https://x.com/acme"}]'
```

### biolink:delete

Exclui uma página de biolink. Pede confirmação, a menos que `-y/--yes` seja passada.

```bash theme={null}
so-me biolink:delete <id> [options]
```

| Opção | Descrição |
| - | - |
| `-y, --yes` | Ignora a confirmação |

```bash Exemplo theme={null}
so-me biolink:delete 550e8400-... --yes
```

### biolink:publish

Alterna um biolink entre publicado e não publicado. O comando inverte o estado em que a página
está no momento e informa o novo status.

```bash theme={null}
so-me biolink:publish <id>
```

```bash Exemplo theme={null}
so-me biolink:publish 550e8400-...
```

***

## Tema

### biolink:theme

Altera o tema de um biolink usando um tema predefinido **ou** cores personalizadas. Informe `--preset` ou uma ou
mais opções de cor personalizada; informar nenhuma delas termina com erro. Se `--preset` for informada, ela tem
precedência e as opções de cor personalizada são ignoradas.

```bash theme={null}
so-me biolink:theme <id> [options]
```

| Opção | Descrição |
| - | - |
| `--preset <theme>` | Tema predefinido: `default`, `dark`, `gradient`, `minimal`, `neon`, `sunset`, `ocean`, `forest` |
| `--bg <color>` | Cor de fundo personalizada (hex) |
| `--text <color>` | Cor do texto personalizada (hex) |
| `--button <color>` | Cor do botão personalizada (hex) |
| `--button-text <color>` | Cor do texto do botão personalizada (hex) |

```bash Exemplos theme={null}
# Usar um tema predefinido
so-me biolink:theme 550e8400-... --preset neon

# Cores personalizadas
so-me biolink:theme 550e8400-... --bg "#1a1a2e" --text "#eaeaea" --button "#5417d7" --button-text "#ffffff"
```

***

## Botões

> **biolink:buttons: listar botões**
>
> Lista todos os botões de um biolink.
>
> ```bash theme={null}
> so-me biolink:buttons <biolink-id>
> ```
>
> ```bash Exemplo theme={null}
> so-me biolink:buttons 550e8400-... --table
> ```

> **biolink:add-button: adicionar um botão**
>
> Adiciona um botão a um biolink. `--type` e `--text` são obrigatórias; as demais opções dependem do
> tipo de botão.
>
> ```bash theme={null}
> so-me biolink:add-button <biolink-id> --type <type> --text <text> [options]
> ```
>
> | Opção | Descrição |
> | - | - |
> | `--type <type>` | Tipo de botão: `link`, `social`, `email`, `phone`, `file`, `text` **(obrigatório)** |
> | `--text <text>` | Texto do botão, máx. 100 caracteres **(obrigatório)** |
> | `--url <url>` | URL (para o tipo `link`/`social`) |
> | `--email <email>` | E-mail (para o tipo `email`) |
> | `--phone <phone>` | Telefone (para o tipo `phone`) |
> | `--file-url <url>` | URL do arquivo (para o tipo `file`) |
> | `--content <content>` | Conteúdo (para o tipo `text`) |
> | `--icon <icon>` | Nome do ícone |
> | `--color <hex>` | Cor personalizada do botão (hex) |
>
> ```bash Exemplos theme={null}
> # Botão de link
> so-me biolink:add-button 550e8400-... --type link --text "Visit Website" --url https://example.com
>
> # Botão de rede social com um ícone e uma cor personalizada
> so-me biolink:add-button 550e8400-... --type social --text "Follow on X" \
>   --url https://x.com/acme --icon x --color "#000000"
>
> # Botão de e-mail
> so-me biolink:add-button 550e8400-... --type email --text "Contact us" --email hello@example.com
> ```

> **biolink:update-button: atualizar um botão**
>
> Atualiza um botão existente. Informe pelo menos uma opção, ou o comando termina com erro.
>
> ```bash theme={null}
> so-me biolink:update-button <biolink-id> <button-id> [options]
> ```
>
> | Opção | Descrição |
> | - | - |
> | `--text <text>` | Texto do botão |
> | `--url <url>` | URL |
> | `--icon <icon>` | Ícone |
> | `--color <hex>` | Cor personalizada |
> | `--active` | Define como ativo |
> | `--inactive` | Define como inativo |
>
> ```bash Exemplo theme={null}
> so-me biolink:update-button 550e8400-... btn-123 --text "Shop now" --url https://example.com/shop --active
> ```

> **biolink:delete-button: excluir um botão**
>
> Exclui um botão. Pede confirmação, a menos que `-y/--yes` seja passada.
>
> ```bash theme={null}
> so-me biolink:delete-button <biolink-id> <button-id> [options]
> ```
>
> | Opção | Descrição |
> | - | - |
> | `-y, --yes` | Ignora a confirmação |
>
> ```bash Exemplo theme={null}
> so-me biolink:delete-button 550e8400-... btn-123 --yes
> ```

> **biolink:reorder-buttons: reordenar botões**
>
> Reordena os botões de um biolink. Passe os IDs dos botões como argumentos posicionais na ordem
> de exibição desejada.
>
> ```bash theme={null}
> so-me biolink:reorder-buttons <biolink-id> <button-ids...>
> ```
>
> ```bash Exemplo theme={null}
> so-me biolink:reorder-buttons 550e8400-... btn-3 btn-1 btn-2
> ```

***

## Galeria

> **biolink:posts: listar posts da galeria**
>
> Lista os posts/itens da galeria de um biolink.
>
> ```bash theme={null}
> so-me biolink:posts <biolink-id>
> ```
>
> ```bash Exemplo theme={null}
> so-me biolink:posts 550e8400-... --table
> ```

> **biolink:add-post: adicionar um post à galeria**
>
> Adiciona um post à galeria. Todas as opções são opcionais.
>
> ```bash theme={null}
> so-me biolink:add-post <biolink-id> [options]
> ```
>
> | Opção | Descrição |
> | - | - |
> | `--image <url>` | URL da imagem |
> | `--caption <text>` | Legenda |
> | `--link <url>` | URL do link |
>
> ```bash Exemplo theme={null}
> so-me biolink:add-post 550e8400-... \
>   --image https://cdn.example.com/photo.jpg \
>   --caption "Behind the scenes" \
>   --link https://example.com/blog
> ```

> **biolink:update-post: atualizar um post da galeria**
>
> Atualiza um post da galeria. Informe pelo menos uma opção, ou o comando termina com erro.
>
> ```bash theme={null}
> so-me biolink:update-post <biolink-id> <post-id> [options]
> ```
>
> | Opção | Descrição |
> | - | - |
> | `--caption <text>` | Legenda |
> | `--link <url>` | URL do link |
> | `--visible` | Define como visível |
> | `--hidden` | Define como oculto |
>
> ```bash Exemplo theme={null}
> so-me biolink:update-post 550e8400-... post-123 --caption "Updated caption" --hidden
> ```

> **biolink:delete-post: excluir um post da galeria**
>
> Exclui um post da galeria. Pede confirmação, a menos que `-y/--yes` seja passada.
>
> ```bash theme={null}
> so-me biolink:delete-post <biolink-id> <post-id> [options]
> ```
>
> | Opção | Descrição |
> | - | - |
> | `-y, --yes` | Ignora a confirmação |
>
> ```bash Exemplo theme={null}
> so-me biolink:delete-post 550e8400-... post-123 --yes
> ```

> **biolink:reorder-posts: reordenar posts da galeria**
>
> Reordena os posts da galeria. Passe os IDs dos posts como argumentos posicionais na ordem de
> exibição desejada.
>
> ```bash theme={null}
> so-me biolink:reorder-posts <biolink-id> <post-ids...>
> ```
>
> ```bash Exemplo theme={null}
> so-me biolink:reorder-posts 550e8400-... post-3 post-1 post-2
> ```

***

## Análises

### biolink:analytics

Obtém as análises de um biolink, incluindo visualizações, cliques e taxa de cliques (CTR).

```bash theme={null}
so-me biolink:analytics <id>
```

```bash Exemplo theme={null}
so-me biolink:analytics 550e8400-... --table
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.