Getting started
Firsty CLI
For builders: set up and check your integration from the terminal.
The Firsty CLI is for builders: teams building on their own self-serve test account. It's also how a coding agent gets connected. Your product itself calls the API over HTTP.
Install and connect
Create a test account if you don't have one yet. Then:
Type the code it shows into the page it opens, and approve. To let your coding agent do all this, paste the prompt from the overview.
What it covers
| Command | What it does |
|---|---|
firsty login, logout | Connect your test account, or end the login |
firsty auth status, token | Check the connection, or print a bearer token |
firsty catalog packages, regions, devices, variants | Browse the catalogue |
firsty esim order, list, get, usage | Order and inspect eSIMs |
firsty esim suspend, reactivate, terminate | Manage an eSIM's lifecycle |
firsty package order, list | Put packages on an eSIM |
Anything else goes over HTTP: firsty auth token gets you a bearer token for
the API reference. Every command takes --json, and
agents.md has the full output contract.
Test and live
The CLI runs on your test account. Live calls go over HTTP with your live credentials.
With no flags, firsty esim order orders a free sandbox eSIM, and
firsty package order puts the sandbox plan on it. --variant travel_ota orders
a real eSIM once you've
topped up. It's
paid from your balance, so the CLI asks first, or needs --yes without a
terminal.
Set up by a Firsty representative?
firsty login only connects builders' test accounts. Use your client ID and
secret with the HTTP tab on each guide. For the test API, the CLI can hold them
too: