Biolinks

Biolinks are public link-in-bio landing pages. Each page has a custom slug, a display name and bio, a theme (preset or custom colors), a list of buttons (links, social, email, phone, file, text), a post/gallery grid, and view/click analytics. This page documents every biolink: command exposed by the CLI.

All commands accept the global flags: --json (default) / --table for output format, --verbose for detailed errors, and --api-key <key> / --api-url <url> to override credentials per call. None of the biolink: commands accept pagination flags.

Core

biolink:list

List all biolink pages for the authenticated organization.

so-me biolink:list

Example

so-me biolink:list --table

biolink:get

Get full details for a single biolink by its internal ID.

so-me biolink:get <id>

Example

so-me biolink:get 550e8400-e29b-41d4-a716-446655440000

biolink:public

View public biolink data using its custom slug. This command resolves the page the same way a visitor would, so it does not require the internal UUID.

so-me biolink:public <slug>

Example

so-me biolink:public my-brand-page

biolink:create

Create a new biolink page. All options are optional.

so-me biolink:create [options]

Option	Description
`--slug <slug>`	Custom URL slug (3-50 alphanumeric chars)
`--name <name>`	Display name
`--bio <bio>`	Bio text

Example

so-me biolink:create --slug mypage --name "My Brand" --bio "Welcome to my page"

biolink:update

Update a biolink page. Provide at least one option, or the command exits with an error.

so-me biolink:update <id> [options]

Option	Description
`--name <name>`	Display name
`--bio <bio>`	Bio text
`--slug <slug>`	Custom slug
`--button-style <style>`	Button style: `rounded`, `square`, `pill`, `outline`
`--show-grid`	Show Instagram grid
`--hide-grid`	Hide Instagram grid
`--social-icons <json>`	Social icons as a JSON array of `{platform, url}` objects

--social-icons must be a valid JSON array; invalid JSON exits with an error before any request is made. --show-grid and --hide-grid set the Instagram grid visibility (pass one, not both).

Examples

# Rename and rewrite the bio
so-me biolink:update 550e8400-... --name "Acme Inc." --bio "Tools for makers"

# Switch button style and show the Instagram grid
so-me biolink:update 550e8400-... --button-style pill --show-grid

# Set social icons (escape the JSON for your shell)
so-me biolink:update 550e8400-... \
  --social-icons '[{"platform":"instagram","url":"https://instagram.com/acme"},{"platform":"x","url":"https://x.com/acme"}]'

biolink:delete

Delete a biolink page. Prompts for confirmation unless -y/--yes is passed.

so-me biolink:delete <id> [options]

Option	Description
`-y, --yes`	Skip the confirmation prompt

Example

so-me biolink:delete 550e8400-... --yes

biolink:publish

Toggle a biolink between published and unpublished. The command flips whichever state the page is currently in and reports the new status.

so-me biolink:publish <id>

Example

so-me biolink:publish 550e8400-...

Theme

biolink:theme

Change a biolink’s theme using either a preset or custom colors. Provide --preset, or one or more custom color options — supplying neither exits with an error. If --preset is given it takes precedence and the custom color options are ignored.

so-me biolink:theme <id> [options]

Option	Description
`--preset <theme>`	Preset theme: `default`, `dark`, `gradient`, `minimal`, `neon`, `sunset`, `ocean`, `forest`
`--bg <color>`	Custom background color (hex)
`--text <color>`	Custom text color (hex)
`--button <color>`	Custom button color (hex)
`--button-text <color>`	Custom button text color (hex)

Examples

# Use a preset
so-me biolink:theme 550e8400-... --preset neon

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

Buttons

biolink:buttons — List buttons

List all buttons for a biolink.

so-me biolink:buttons <biolink-id>

Example

so-me biolink:buttons 550e8400-... --table

biolink:add-button — Add a button

Add a button to a biolink. --type and --text are required; the remaining options depend on the button type.

so-me biolink:add-button <biolink-id> --type <type> --text <text> [options]

Option	Description
`--type <type>`	Button type: `link`, `social`, `email`, `phone`, `file`, `text` (required)
`--text <text>`	Button text, max 100 chars (required)
`--url <url>`	URL (for `link`/`social` type)
`--email <email>`	Email (for `email` type)
`--phone <phone>`	Phone (for `phone` type)
`--file-url <url>`	File URL (for `file` type)
`--content <content>`	Content (for `text` type)
`--icon <icon>`	Icon name
`--color <hex>`	Custom button color (hex)

Examples

# Link button
so-me biolink:add-button 550e8400-... --type link --text "Visit Website" --url https://example.com

# Social button with an icon and custom color
so-me biolink:add-button 550e8400-... --type social --text "Follow on X" \
  --url https://x.com/acme --icon x --color "#000000"

# Email button
so-me biolink:add-button 550e8400-... --type email --text "Contact us" --email [email protected]

biolink:update-button — Update a button

Update an existing button. Provide at least one option, or the command exits with an error.

so-me biolink:update-button <biolink-id> <button-id> [options]

Option	Description
`--text <text>`	Button text
`--url <url>`	URL
`--icon <icon>`	Icon
`--color <hex>`	Custom color
`--active`	Set active
`--inactive`	Set inactive

Example

so-me biolink:update-button 550e8400-... btn-123 --text "Shop now" --url https://example.com/shop --active

biolink:delete-button — Delete a button

Delete a button. Prompts for confirmation unless -y/--yes is passed.

so-me biolink:delete-button <biolink-id> <button-id> [options]

Option	Description
`-y, --yes`	Skip the confirmation prompt

Example

so-me biolink:delete-button 550e8400-... btn-123 --yes

biolink:reorder-buttons — Reorder buttons

Reorder a biolink’s buttons. Pass the button IDs as positional arguments in the desired display order.

so-me biolink:reorder-buttons <biolink-id> <button-ids...>

Example

so-me biolink:reorder-buttons 550e8400-... btn-3 btn-1 btn-2

Gallery

biolink:posts — List gallery posts

List the posts/gallery items for a biolink.

so-me biolink:posts <biolink-id>

Example

so-me biolink:posts 550e8400-... --table

biolink:add-post — Add a gallery post

Add a post to the gallery. All options are optional.

so-me biolink:add-post <biolink-id> [options]

Option	Description
`--image <url>`	Image URL
`--caption <text>`	Caption
`--link <url>`	Link URL

Example

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 — Update a gallery post

Update a gallery post. Provide at least one option, or the command exits with an error.

so-me biolink:update-post <biolink-id> <post-id> [options]

Option	Description
`--caption <text>`	Caption
`--link <url>`	Link URL
`--visible`	Set visible
`--hidden`	Set hidden

Example

so-me biolink:update-post 550e8400-... post-123 --caption "Updated caption" --hidden

biolink:delete-post — Delete a gallery post

Delete a gallery post. Prompts for confirmation unless -y/--yes is passed.

so-me biolink:delete-post <biolink-id> <post-id> [options]

Option	Description
`-y, --yes`	Skip the confirmation prompt

Example

so-me biolink:delete-post 550e8400-... post-123 --yes

biolink:reorder-posts — Reorder gallery posts

Reorder gallery posts. Pass the post IDs as positional arguments in the desired display order.

so-me biolink:reorder-posts <biolink-id> <post-ids...>

Example

so-me biolink:reorder-posts 550e8400-... post-3 post-1 post-2

Analytics

biolink:analytics

Get analytics for a biolink, including views, clicks, and click-through rate (CTR).

so-me biolink:analytics <id>

Example

so-me biolink:analytics 550e8400-... --table

Getting Started

Publishing

AI Studio

Inbox & Engagement

Analytics

Biolink

Team & Collaboration

Settings & Billing

Webhooks

Support

Core

biolink:list

biolink:get

biolink:public

biolink:create

biolink:update

biolink:delete

biolink:publish

Theme

biolink:theme

Buttons

Gallery

Analytics

biolink:analytics

​Core

​biolink:list

​biolink:get

​biolink:public

​biolink:create

​biolink:update

​biolink:delete

​biolink:publish

​Theme

​biolink:theme

​Buttons

​Gallery

​Analytics

​biolink:analytics

Core

biolink:list

biolink:get

biolink:public

biolink:create

biolink:update

biolink:delete

biolink:publish

Theme

biolink:theme

Buttons

Gallery

Analytics

biolink:analytics