Docs / Cli

Install and authenticate the SmallForce CLI

Install the npm package globally:

npm install --global smallforce
smallforce --help

Or run the latest published package without a global installation:

npx smallforce --help

Set the organization API key in the environment and verify which organization it authenticates:

export SMALLFORCE_API_KEY="sf_..."
smallforce org get

The production backend defaults to https://backend.smallforcehq.com. Local or staging environments can override it with SMALLFORCE_BACKEND_URL or --backend-url.

Global options

OptionPurpose
--api-key <key>Override SMALLFORCE_API_KEY for one command
--backend-url <url>Override SMALLFORCE_BACKEND_URL
--jsonPrint stable machine-readable output
--textForce human-readable output
--format text|jsonSelect an output format explicitly
--helpShow the current command contract
--versionPrint the installed CLI version

Do not place API keys directly in scripts, documentation, chat messages, or version-controlled files. Prefer environment or secret-management facilities.