simforge keys

Reference for simforge keys: usage, arguments and flags, generated from the CLI.

Generated from the CLI’s own help (CLI 0.2.0-rc.5). Global flags and exit codes are on the command reference.

keys create

Create an API key for this workspace; its secret is printed once

simforge keys create [OPTIONS] --name <NAME>

Argument / flag	Notes	What
--name NAME	required	A name to recognize the key by (1-200 characters)
--scope SCOPE	repeatable	A scope the key holds (repeatable). Default: maps:read scenarios:read scenarios:write datasets:read runs:read runs:write artifacts:read usage:read
--expires-in-days DAYS		Expire the key after this many days (1-3650). Default: no expiry

keys list

List the workspace’s API keys (never their secrets)

simforge keys list [OPTIONS]

keys revoke

Revoke an API key now; requests with it stop resolving immediately

simforge keys revoke [OPTIONS] <ID>

Argument / flag	Notes	What
<id>	required	The key’s id (key_…, from simforge keys list)