Install Figena CLI and run your first command

Overview

Figena CLI brings approved Figena work into the terminal. You sign in through the browser, run published agent versions, manage knowledge bases, and call OpenPort actions, and every command returns a clear result that people and scripts can read.

Requirements

• Node.js 22. figena doctor reports any other Node version as unsupported.
• A Figena account in a workspace that is approved for CLI access.
• Network access from your terminal to the Figena API at https://api.figena.com/api.

Install the CLI

Install the package globally with the package manager you already use:

npm install -g @figena/cli

Run figena --version to confirm the installation. It prints the CLI package, version, and Node.js version.

Set up in three steps

1. 1Create a profile that points at the Figena API. config init also makes it the active profile.
2. 2Sign in. Your browser opens a Figena approval page; approve the request there.
3. 3Run figena doctor to check the setup.

figena config init --profile production --api-base-url https://api.figena.com/apifigena auth loginfigena doctor

Read the doctor report

figena doctor runs these checks and lists each one with its result:

• node: the Node.js version, which must be 22.x.
• profile and apiBaseUrl: the profile in use and whether it has an API address.
• auth: whether a signed-in session or an Agent Key is available.
• storePermissions: whether the local config and credentials files are private to your user.
• apiVersion and apiHealth: whether the API answers its version and health checks.

Only an unsupported Node.js version or a missing API address block the setup; the report then ends with “Doctor found blocking issues”. Missing credentials are reported but don’t block, because you may sign in afterwards.

Get help

Run figena help, figena --help, or figena -h to list every command. An unknown command prints the same list and exits with code 2.

Next steps

1. 1Authenticate Figena CLI: browser sign-in, Agent Keys, and where credentials are stored.
2. 2Configure profiles: settings for several workspaces or environments.
3. 3Use CLI output in scripts: output formats, result fields, and exit codes.