Short answer
Tell an AI coding agent "create a link using Linkbreakers" and it can do the whole thing on its own, with no account set up beforehand. One command, npx -y linkbreakers-cli signup --email [email protected], creates a workspace and saves its API token. The next command creates the link, and the one after reads analytics. The whole sequence takes under 10 seconds, including downloading the CLI. You then claim the workspace with a link and a 6-digit code we email you.
Quick summary
- One command to start:
signupcreates a free workspace and saves an API token in the CLI config. No dashboard, no copy-pasting keys. - Everything the API does, from the terminal: every API operation is a CLI command, generated from the OpenAPI document. Links, QR codes, workflows, visitors and analytics are all available.
- Fast: in our tests the full sequence (download the CLI, sign up, create a link, read analytics) took about 5 seconds.
- You stay in control: the workspace is yours once you open the emailed link and enter the code. Unclaimed, it is deleted with everything in it after 24 hours.
- Built for agents: output is JSON, and every error says what to do next.
How it works
1. The agent signs up
npx -y linkbreakers-cli signup --email [email protected]
The answer is JSON the agent reads directly: the workspace id, what the token can do, and a claim block saying where we emailed the claim link. The link and its code go only to your inbox, never to the agent, so claiming also verifies your email.
{
"workspace_id": "2039ba07-6f09-40e0-a0d5-9283e37a3737",
"token": "saved",
"scopes": ["links:write", "qrcodes:write", "workflows:write", "analytics:read", "..."],
"claim": {
"status": "emailed",
"email": "[email protected]",
"required_by": "2026-10-22T20:26:23Z"
}
}
2. The agent creates the link
npx -y linkbreakers-cli links create --destination https://example.com --name "Spring menu" --wait-for-qrcode
The response holds the short link (entrypoint) and a signed URL to the QR code image.
3. The agent reads analytics
npx -y linkbreakers-cli analytics-data get-top-links
npx -y linkbreakers-cli metrics get-workspace-metric
4. You claim the workspace
Open the link we emailed you and enter the 6-digit code. Set a password or continue with Google or Microsoft, and the workspace is yours, with the links the agent made. The agent does not need to do anything: the next command it runs picks up the claim, and its token gains the claimed workspace's wider permissions.
Why it is this fast
- No account step. The workspace and its token are created in a single request, so the agent never stops to ask you for a key.
- No SDK to learn. The CLI is generated from the same OpenAPI document as the API, so every operation is a command with flags named after the request's fields.
--helpon any command shows them. - No install step.
npx -y linkbreakers-clidownloads the binary for your platform on first use. Install it withnpm install -g linkbreakers-clior Homebrew to drop the prefix.
Limits and caveats
- Claim within 24 hours. An unclaimed workspace is deleted with its links, QR codes and analytics 24 hours after signup. The CLI reminds the agent on every command until then.
- Free plan. The workspace starts on the free plan, which covers a handful of links a month. Upgrade from the dashboard once it is claimed.
- One email per sign-up. The agent needs your email address: that is where the claim link goes. Claim emails to one address are capped at three a day.
- Already have an account? Skip
signup: create a token in the dashboard under API Tokens and runlinkbreakers auth set-token --token <token>.
Frequently asked questions
Which AI agents does this work with?
Any agent that can run terminal commands: Claude Code, Cursor, Windsurf, GitHub Copilot in agent mode, or your own. Agents that work through MCP instead can connect to the Linkbreakers MCP server.
Does the agent see my password or account?
No. The agent only gets a token for the workspace it created. You claim the workspace yourself, in your browser, with the code we email you.
What happens if I never claim the workspace?
It is deleted, with everything in it, 24 hours after signup. Nothing is left behind.
Can the agent create more API keys or invite people?
No. Before you claim it, the token can manage links, QR codes, workflows and page themes and read analytics. Once you claim it, it can also manage media and webhooks and read visitors, domains and members. It can never create API tokens or invite people: those stay with you in the dashboard.
Sources
- How to install and use the Linkbreakers CLI
- How Linkbreakers works with AI agents
- Linkbreakers CLI on GitHub
Last reviewed
2026-10-21
About the Author
Laurent Schaffner
Founder & Engineer at Linkbreakers
Passionate about building tools that help businesses track and optimize their digital marketing efforts. Laurent founded Linkbreakers to make QR code analytics accessible and actionable for companies of all sizes.
Related Articles
How to automate QR code campaigns with MCP
Step-by-step guide to automating QR code campaign creation, workflow setup, and analytics retrieval using the Model Context Protocol (MCP) with Claude Code or any MCP-compatible AI client.
Programmatic QR code generation: API vs AI agents
Compare three approaches to programmatic QR code generation — REST API with SDKs, CLI automation, and AI agents via MCP. Understand when to use each method and how Linkbreakers supports all three.
The developer's guide to QR code tracking APIs
Technical guide to QR code tracking APIs — how scan events work, what data you can collect, how to build analytics dashboards, and how to integrate QR tracking into your application with Linkbreakers' REST API and SDKs.
On this page
Need more help?
Can't find what you're looking for? Get in touch with our support team.
Contact Support