Documentation Index
Fetch the complete documentation index at: https://docs.sfcompute.com/llms.txt
Use this file to discover all available pages before exploring further.
A workspace groups resources within an account. Capacities, instances, instance templates,
deployments, procurements, images, subnets, and tags all belong to a workspace. Every new account
comes with a workspace named default. It’s not special — it can be renamed or deleted like any
other workspace.
Workspaces have to be specified
Every API request that creates, lists, or operates on workspace-scoped resources targets a
workspace. Not all resources are workspace-scoped — see resource paths
for which resources live at which scope.
- Creating resources: include
"workspace" in the request body
- Listing resources: pass
?workspace= as a query parameter
- Getting a single resource: use a resource path or an ID
# Create an instance in a specific workspace
sf instances create --capacity training-cluster --workspace production
# List instances in a workspace
sf instances list --workspace production
Set your active workspace
If you haven’t set an active workspace, the CLI falls back to default. Set one with
sf workspaces use <name>. Override per-command with --workspace <name>.
sf workspaces use production
sf instances list --workspace staging # one-off override
Create a workspace
sf workspaces create --name production
List workspaces
The active workspace is marked with an arrow in the leftmost column.
sf workspaces list
NAME CREATED
default Mar 1, 2025, 12:00am
→ production Jun 15, 2025, 12:00am
staging Jun 15, 2025, 12:00am
View a workspace
sf workspaces get production
│ WORKSPACE production
│ ID ws_4UpxzQw7A8N
│ RESOURCE PATH sfc:workspace:acme:production
└ CREATED Jun 15, 2025, 12:00am
Cross-workspace references with resource paths
Every resource has a resource path that embeds the workspace. Resource
paths can be used anywhere a name or ID is accepted, enabling cross-workspace references without
switching context.
# Create an instance in `production` on a capacity owned by the `shared` workspace
sf instances create \
--workspace production \
--capacity sfc:capacity:acme:shared:training-pool
Delete a workspace
sf workspaces delete staging
