Getting started

Installation

Install the Froglet CLI and the TypeScript SDK.

CLI

Recommended (Node shim resolves the platform binary at install):

npm  install -g @kortix/froglet-cli
pnpm add  -g @kortix/froglet-cli

From source (needs Rust):

cargo install --git https://github.com/kortix-ai/froglet froglet-cli

Verify:

$ froglet --version
froglet 0.1.0

Supported platforms: macOS arm64/x64, Linux arm64/x64 (glibc), Windows x64.

npm  install @kortix/froglet-sdk
pnpm add @kortix/froglet-sdk

Node 18+ or anywhere fetch is global. No Node-specific imports.

Create an API key on the dashboard's API keys page (starts with fl_), then log in once:

$ froglet auth login
paste your fl_… key: ********************************
logged in to https://api.froglet.sh as workspace `acme`

Non-interactive:

froglet auth login --token "$FROGLET_API_KEY"

Or skip the saved config and use env vars — every command picks them up:

export FROGLET_API_KEY=fl_…
export FROGLET_API_URL=https://api.froglet.sh   # optional, this is the default

Var	Effect
`FROGLET_API_KEY`	Bearer token, sent as `Authorization: Bearer …`.
`FROGLET_API_URL`	Override the API base URL.

Env vars win over the stored config.

$ froglet me
via         api_key
workspace   acme (acme)
role        owner
scopes      workspace:read, sandboxes:read, …

auth whoami shows the current key + URL. auth logout wipes the saved config (env vars still work).

Flag	Effect
`--json`	Print the raw API payload. Designed for piping.
`--url <url>`	Override the API base URL for one invocation.