Docs
Open SmallForce

CLI

SmallForce CLI: AI employees commands

Discover the AI employees available in this organization’s OS

This page covers 1 smallforce employees command. It is generated from SmallForce CLI 0.1.17; run smallforce employees --help (or any command with --help) to see the same reference for the version you have installed. New to the CLI? Start with installation and authentication and JSON output.

Agent workflow:
  1. Run smallforce employees list --json.
  2. Select the employee whose role matches the task.
  3. Start a conversation with smallforce chat send "<message>" --employee <slug> --wait.

The API key determines the organization. The backend resolves its current OS;
there is no organization or deployment selector in this command group.

Common options

Most commands accept these options as well as their own. Every command also accepts -h, --help.

OptionDescription
--api-key <key>SmallForce API key, or set SMALLFORCE_API_KEY
--backend-url <url>SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
--jsonPrint stable machine-readable JSON
--textPrint human-readable text
--format <format>Output format: text or json

smallforce employees list

List active AI employees and their stable slugs

Usage: smallforce employees list [options]

Also accepts the common options listed at the top of this page.

Examples:
  $ smallforce employees list
  $ smallforce employees list --json

Use the returned slug with chat send --employee. Prefer --json when another
agent is selecting an employee programmatically.