SimpleFunctions Developer Manual

Use the CLI when a human operator, local script, cron job, or external coding agent owns the runtime.

1. Install

npm install -g @spfunctions/cli
sf status --json

2. Configure auth when needed

Public query, world, and market reads can start without exchange keys. Account, portfolio, intent, and execution workflows need a SimpleFunctions API key.

sf login
# or
export SF_API_KEY="sf_..."

3. Run the first reads

sf query "Fed rate cut" --json --limit 3
sf world --json
sf world --delta --json --since 1h
sf inspect KXRATECUT-26DEC31 --json

Every command above should print one JSON document on stdout.

4. Discover commands before acting

sf describe --all --json
sf tools plan "read world state and inspect Fed markets" --json

Use the manifest to check auth, side effects, JSON support, and arguments before an agent calls a command.

5. Use direct contract tools

sf agent --tool world.read --stream-json --compact
sf agent --tool markets.search --input '{"query":"Fed CPI","limit":3}' --ndjson --compact

sf agent --tool accepts canonical dotted names from /api/contracts/tools, not broad hosted compatibility names.

Next steps

Agentic CLI

Full CLI control-plane guide.

Command reference

Command inventory and examples.

API quickstart

Call the same surfaces over HTTP.

Agent SDK quickstart

Embed the loop in TypeScript.

Get started

Quickstarts

CLI quickstart

1. Install

2. Configure auth when needed

3. Run the first reads

4. Discover commands before acting

5. Use direct contract tools

Next steps

Agentic CLI

Command reference

API quickstart

Agent SDK quickstart

​1. Install

​2. Configure auth when needed

​3. Run the first reads

​4. Discover commands before acting

​5. Use direct contract tools

​Next steps

Agentic CLI

Command reference

API quickstart

Agent SDK quickstart

1. Install

2. Configure auth when needed

3. Run the first reads

4. Discover commands before acting

5. Use direct contract tools

Next steps