Install & sign in
Install the CLI, sign in once with your Google account, and check that it works. It takes three steps.
1 · Install the CLI
You need Node 22.13 or newer. The CLI is an npm package named ignitify.
$ npm install --global ignitify$ ignitify --versionignitify 1.0.0 (built for API 1)API: 1 at https://api.ignitify.dev
2 · Sign in
A new account starts on the free plan, with no key. The CLI gets its key when you run ignitify login and approve it in your browser.
$ ignitify loginTo sign in, open this page: https://account.ignitify.dev/web/device?code=BCDFGHJKCheck that the page shows this code: BCDF-GHJKWaiting for approval. The code expires in 10 minutes.✓ Signed in as ada (tnt_Xk29QmWr5LdA) Key "ada-laptop" is saved in /home/ada/.config/ignitify/credentials.json It expires after 90 days without use. Each use renews it.
The CLI also opens the page in your browser. Do these steps there:
- If the page asks, sign in with Google. The first sign-in creates your account on the free plan.
- Compare the code on the page with the code in your terminal. They must be the same.
- Choose Approve. Choose Deny if you did not run
ignitify loginyourself.
The terminal then prints the line that starts with ✓ Signed in.
Name the key
Each machine has one key. Its label is the host name of the machine. Use --name to choose another label, for example when two machines have the same host name.
$ ignitify login --name build-boxA second login with the same label replaces the old key. The old key stops working. The free plan allows one key. If your account is at its key limit, the approve page asks you to pick the key to replace.
3 · Check it works
ignitify whoami shows your workspace, your plan and what you use. More lines follow the part shown here.
$ ignitify whoamiTenant Profiletenant_id 019f2b10-3c55-7a01-b2e4-9d0c61f7a8b3resource_id tnt_Xk29QmWr5LdAname adastatus ACTIVEtier free v1bound_by tier-entitlementUsage & Limits…
If you are not signed in, a command stops with this message:
$ ignitify whoamiError: Not signed in. Run 'ignitify login', or set the IGNITIFY_API_KEY environment variable.
Your account page
Open account.ignitify.dev/web/profile and sign in with Google. The page shows:
| Part | What it shows |
|---|---|
| Workspace | The name, the id (tnt_…), the status and the plan of your workspace. |
| Plan limits | A table of what your plan allows: tasks, running VMs, pinned VMs, image storage and scratch storage per VM. |
| Keys | Each key with its label, id, when it was last used, when it expires, when it was created and how it was issued. Choose Revoke to stop a key at once. |
| Connect the CLI | The command ignitify login. The page then asks you to approve it. |
Choose Sign out on the page to end your browser session. This does not revoke any key.
Sign out of the CLI
ignitify logout revokes the key of this machine, then deletes the saved file.
$ ignitify logout✓ Signed out. The key was revoked and the saved credentials were deleted.
If the platform cannot be reached, the CLI still deletes the file. It then warns you that the key may still work, and exits with code 1. Revoke the key on your account page.
Where the key is stored
The CLI saves the key in ~/.config/ignitify/credentials.json. If XDG_CONFIG_HOME is set, the file is $XDG_CONFIG_HOME/ignitify/credentials.json. Only you can read it (mode 0600). The CLI refuses a file that is a link, that belongs to another user, or that other users can read.
The key lasts 90 days without use. Each use renews it. It is tied to the server that issued it, so the CLI never sends it to another address.
Upgrade
$ npm install --global ignitify@latestCI keys are not available yet
You cannot get a key for CI or scripts today. A key comes only from ignitify login, which needs a person to approve it in a browser. A way to make a key for CI is planned, but not released.
The CLI reads the IGNITIFY_API_KEY environment variable first. If it is set and not empty, the CLI uses it instead of the saved key.