Skip to main content
Command Line & API

For people who would rather type, not click

The firecradle command line tool is a full client for everything the web interface can do. Script it, automate it, or just use it because it is faster than a mouse.

firecradle CLI · firecradle top · REST API

A full client, not a shortcut

Every command talks to the same API the website uses, so nothing is missing and nothing gets special treatment.

Everything the website can do
The firecradle command checks status, reads and changes firewall rules, manages VPN users, and pulls reports, all from a terminal.
Human tables or plain JSON
Every command prints a readable table by default. Add --json and you get plain data instead, ready for a script to read.
Same rules as the website
The CLI does not get its own special access. Whatever your login is allowed to see or change on the website is what it can do here too.
Reports from a script
Generate a report or list saved ones without opening a browser at all, which is handy for scheduled jobs.
A terminal window running the firecradle command-line tool, showing a status command output as a formatted table
firecradle status, straight from a terminal.

A live view, right in your terminal

firecradle top is a full-screen dashboard that never needs a browser tab.

firecradle top
A full-screen, live-updating view in your terminal: traffic per connection, the busiest devices, recent threats, and how each internet line is doing, all refreshing on their own.
Tab completion
Type firecradle and press tab, and your shell fills in the rest of the command for you. Works in bash and zsh.
A proper man page
Type man firecradle and read the full reference offline, the same way you would for any other command-line tool.

Keep your setup in git, not just in the box

Export your configuration to a file, review changes like a team, and apply the approved version anywhere.

API tokens with scoped permissions
Create a token for a script that can only do what that script needs, instead of handing out full admin access everywhere.
Config as code
Export your whole setup to one file. Run the export twice and you get the exact same file back — that is config as code. Keep it in git, review changes like any other code, then apply the approved version to a new box.
Built for teams
Nobody applies a change from memory. Somebody proposes it, somebody else reviews it in a pull request, and only then does it reach a real firewall.
A REST API underneath
The CLI is a client for the same API you can call yourself: around 741 routes across roughly 112 modules, for anyone building their own automation.

What it runs on

~741
REST API routes you can call directly
~112
API modules covering every feature
JSON or table
Output format, your choice, per command
Scoped tokens
A token only does what you allow it to do

How people actually use this

Checking ten firewalls without ten browser tabs

The problem: An admin looks after several offices and opening a browser tab for each one, every morning, wastes time.

What Firecradle does:
Run firecradle status against each box from one terminal
Script it once and check every site in seconds
Add --json and feed the result into your own monitoring
The same login and permissions apply everywhere

Reviewing a firewall change like a code change

The problem: A team wants a second pair of eyes on firewall changes before they go live, the same way they review code.

What Firecradle does:
Export the current configuration to a file with config export
Commit it to git and open a pull request for the proposed change
A teammate reviews the exact change, not a verbal description of it
Apply the approved file to the box with config apply

Everything here is included

No add-on licence, no separate download

The firecradle command line, covering everything the website can do
firecradle top, a live full-screen terminal dashboard
Shell completion for bash and zsh
A full man page you can read offline
API tokens scoped to only what a script needs
Config export and apply, in a checksum-stable file
A REST API for building your own automation
The same permissions and roles as the website, everywhere

Common questions

Do I need the command line, or is the website enough?

The website is enough for almost everyone. The CLI exists for people who prefer typing, and for scripts and automation that need to talk to Firecradle without a browser.

Can the CLI do things the website cannot?

No. It is a client for the same API the website uses, so it follows the same permissions. It is a different way in, not a back door.

What does config as code actually mean in practice?

It means your firewall settings live in a plain text file instead of only inside the box. You can store that file in git, see exactly what changed between versions, and have someone approve a change before it is applied.

Can I build my own tools against Firecradle?

Yes. There is a full REST API behind both the website and the CLI, with around 741 routes, so you can automate anything the interface can do.

Script it, or click it — your choice

The CLI and REST API are part of every Firecradle appliance, no extra licence required. Try it free for 30 days.

No credit card required · Cancel anytime · 30-day free trial