Salesforce Hardened
by @snazar-faberlens
Query and manage Salesforce CRM data via the Salesforce CLI (`sf`). Run SOQL/SOSL queries, inspect object schemas, create/update/delete records, bulk import/...
clawhub install salesforce-hardenedπ About This Skill
name: salesforce-hardened description: "Query and manage Salesforce CRM data via the Salesforce CLI (
sf). Run SOQL/SOSL queries, inspect object schemas, create/update/delete records, bulk import/export, execute Apex, deploy metadata, and make raw REST API calls."
homepage: https://developer.salesforce.com/tools/salesforcecli
metadata: {"clawdbot":{"emoji":"βοΈ","requires":{"bins":["sf"]},"install":[{"id":"npm","kind":"node","package":"@salesforce/cli","bins":["sf"],"label":"Install Salesforce CLI (npm)"}]}}
Salesforce Skill
Use the Salesforce CLI (sf) to interact with Salesforce orgs. The CLI must be authenticated before use. Always add --json for structured output.
If the sf binary is not available, install it via npm (npm install -g @salesforce/cli) or download it from https://developer.salesforce.com/tools/salesforcecli. After installing, authenticate immediately with sf org login web to connect to a Salesforce org.
Authentication and Org Management
Log in (opens browser)
sf org login web --alias my-org
Other login methods:
# JWT-based login (CI/automation)
sf org login jwt --client-id --jwt-key-file server.key --username user@example.com --alias my-orgLogin with an existing access token
sf org login access-token --instance-url https://mycompany.my.salesforce.comLogin via SFDX auth URL (from a file)
sf org login sfdx-url --sfdx-url-file authUrl.txt --alias my-org
Manage orgs
# List all authenticated orgs
sf org list --jsonDisplay info about the default org (access token, instance URL, username)
sf org display --jsonDisplay info about a specific org
sf org display --target-org my-org --jsonDisplay with SFDX auth URL (sensitive - contains refresh token)
sf org display --target-org my-org --verbose --jsonOpen org in browser
sf org open
sf org open --target-org my-orgLog out
sf org logout --target-org my-org
Configuration and aliases
# Set default target org
sf config set target-org my-orgList all config variables
sf config listGet a specific config value
sf config get target-orgSet an alias
sf alias set prod=user@example.comList aliases
sf alias list
Querying Data (SOQL)
Standard SOQL queries via the default API:
# Basic query
sf data query --query "SELECT Id, Name, Email FROM Contact LIMIT 10" --jsonWHERE clause
sf data query --query "SELECT Id, Name, Amount, StageName FROM Opportunity WHERE StageName = 'Closed Won'" --jsonRelationship queries (parent-to-child)
sf data query --query "SELECT Id, Name, (SELECT LastName, Email FROM Contacts) FROM Account LIMIT 5" --jsonRelationship queries (child-to-parent)
sf data query --query "SELECT Id, Name, Account.Name FROM Contact" --jsonLIKE for text search
sf data query --query "SELECT Id, Name FROM Account WHERE Name LIKE '%Acme%'" --jsonDate filtering
sf data query --query "SELECT Id, Name, CreatedDate FROM Lead WHERE CreatedDate = TODAY" --jsonORDER BY + LIMIT
sf data query --query "SELECT Id, Name, Amount FROM Opportunity ORDER BY Amount DESC LIMIT 20" --jsonInclude deleted/archived records
sf data query --query "SELECT Id, Name FROM Account" --all-rows --jsonQuery from a file
sf data query --file query.soql --jsonTooling API queries (metadata objects like ApexClass, ApexTrigger)
sf data query --query "SELECT Id, Name, Status FROM ApexClass" --use-tooling-api --jsonOutput to CSV file
sf data query --query "SELECT Id, Name, Email FROM Contact" --result-format csv --output-file contacts.csvTarget a specific org
sf data query --query "SELECT Id, Name FROM Account" --target-org my-org --json
For queries returning more than 10,000 records, use Bulk API instead:
sf data export bulk --query "SELECT Id, Name, Email FROM Contact" --output-file contacts.csv --result-format csv --wait 10
sf data export bulk --query "SELECT Id, Name FROM Account" --output-file accounts.json --result-format json --wait 10
Text Search (SOSL)
SOSL searches across multiple objects at once:
# Search for text across objects
sf data search --query "FIND {John Smith} IN ALL FIELDS RETURNING Contact(Name, Email), Lead(Name, Email)" --jsonSearch in name fields only
sf data search --query "FIND {Acme} IN NAME FIELDS RETURNING Account(Name, Industry), Contact(Name)" --jsonSearch from a file
sf data search --file search.sosl --jsonOutput to CSV
sf data search --query "FIND {test} RETURNING Contact(Name)" --result-format csv
Single Record Operations
Get a record
# By record ID
sf data get record --sobject Contact --record-id 003XXXXXXXXXXXX --jsonBy field match (WHERE-like)
sf data get record --sobject Account --where "Name=Acme" --jsonBy multiple fields (values with spaces need single quotes)
sf data get record --sobject Account --where "Name='Universal Containers' Phone='(123) 456-7890'" --json
Create a record (confirm with user first)
sf data create record --sobject Contact --values "FirstName='Jane' LastName='Doe' Email='jane@example.com'" --jsonsf data create record --sobject Account --values "Name='New Company' Website=www.example.com Industry='Technology'" --json
Tooling API object
sf data create record --sobject TraceFlag --use-tooling-api --values "DebugLevelId=7dl... LogType=CLASS_TRACING" --json
Update a record (confirm with user first)
# By ID
sf data update record --sobject Contact --record-id 003XXXXXXXXXXXX --values "Email='updated@example.com'" --jsonBy field match
sf data update record --sobject Account --where "Name='Old Acme'" --values "Name='New Acme'" --jsonMultiple fields
sf data update record --sobject Account --record-id 001XXXXXXXXXXXX --values "Name='Acme III' Website=www.example.com" --json
Delete a record (require explicit user confirmation)
# By ID
sf data delete record --sobject Account --record-id 001XXXXXXXXXXXX --jsonBy field match
sf data delete record --sobject Account --where "Name=Acme" --json
Bulk Data Operations (Bulk API 2.0)
For large datasets (thousands to millions of records):
Bulk export
# Export to CSV
sf data export bulk --query "SELECT Id, Name, Email FROM Contact" --output-file contacts.csv --result-format csv --wait 10Export to JSON
sf data export bulk --query "SELECT Id, Name FROM Account" --output-file accounts.json --result-format json --wait 10Include soft-deleted records
sf data export bulk --query "SELECT Id, Name FROM Account" --output-file accounts.csv --result-format csv --all-rows --wait 10Resume a timed-out export
sf data export resume --job-id 750XXXXXXXXXXXX --json
Bulk import
# Import from CSV
sf data import bulk --file accounts.csv --sobject Account --wait 10Resume a timed-out import
sf data import resume --job-id 750XXXXXXXXXXXX --json
Bulk upsert
sf data upsert bulk --file contacts.csv --sobject Contact --external-id Email --wait 10
Bulk delete
# Delete records listed in CSV (CSV must have an Id column)
sf data delete bulk --file records-to-delete.csv --sobject Contact --wait 10
Tree export/import (for related records)
# Export with relationships into JSON tree format
sf data export tree --query "SELECT Id, Name, (SELECT Name, Email FROM Contacts) FROM Account" --jsonExport with a plan file (for multiple objects)
sf data export tree --query "SELECT Id, Name FROM Account" --plan --output-dir export-dataImport from tree JSON files
sf data import tree --files Account.json,Contact.jsonImport using a plan definition file
sf data import tree --plan Account-Contact-plan.json
Schema Inspection
# Describe an object (fields, relationships, picklist values)
sf sobject describe --sobject Account --jsonDescribe a custom object
sf sobject describe --sobject MyCustomObject__c --jsonDescribe a Tooling API object
sf sobject describe --sobject ApexClass --use-tooling-api --jsonList all objects
sf sobject list --jsonList only custom objects
sf sobject list --sobject custom --jsonList only standard objects
sf sobject list --sobject standard --json
Execute Apex Code
# Execute Apex from a file
sf apex run --file script.apex --jsonRun interactively (type code, press Ctrl+D to execute)
sf apex runRun Apex tests
sf apex run test --test-names MyTestClass --jsonGet test results
sf apex get test --test-run-id 707XXXXXXXXXXXX --jsonView Apex logs
sf apex list log --json
sf apex get log --log-id 07LXXXXXXXXXXXX
REST API (Advanced)
Make arbitrary authenticated REST API calls:
# GET request
sf api request rest 'services/data/v62.0/limits' --jsonList API versions
sf api request rest '/services/data/' --jsonCreate a record via REST
sf api request rest '/services/data/v62.0/sobjects/Account' --method POST --body '{"Name":"REST Account","Industry":"Technology"}' --jsonUpdate a record via REST (PATCH)
sf api request rest '/services/data/v62.0/sobjects/Account/001XXXXXXXXXXXX' --method PATCH --body '{"BillingCity":"San Francisco"}' --jsonGraphQL query
sf api request graphql --body '{"query":"{ uiapi { query { Account { edges { node { Name { value } } } } } } }"}' --jsonCustom headers
sf api request rest '/services/data/v62.0/limits' --header 'Accept: application/xml'Save response to file
sf api request rest '/services/data/v62.0/limits' --stream-to-file limits.json
Metadata Deployment and Retrieval
# Deploy metadata to an org
sf project deploy start --source-dir force-app --jsonDeploy specific metadata components
sf project deploy start --metadata ApexClass:MyClass --jsonRetrieve metadata from an org
sf project retrieve start --metadata ApexClass --jsonCheck deploy status
sf project deploy report --job-id 0AfXXXXXXXXXXXX --jsonGenerate a new Salesforce DX project
sf project generate --name my-projectList metadata components in the org
sf project list ignored --json
Diagnostics
# Run CLI diagnostics
sf doctorCheck CLI version
sf versionSee what is new
sf whatsnew
Common SOQL Patterns
-- Count records
SELECT COUNT() FROM Contact WHERE AccountId = '001XXXXXXXXXXXX'-- Aggregate query
SELECT StageName, COUNT(Id), SUM(Amount) FROM Opportunity GROUP BY StageName
-- Date literals
SELECT Id, Name FROM Lead WHERE CreatedDate = LAST_N_DAYS:30
-- Subquery (semi-join)
SELECT Id, Name FROM Account WHERE Id IN (SELECT AccountId FROM Contact WHERE Email LIKE '%@acme.com')
-- Polymorphic lookup
SELECT Id, Who.Name, Who.Type FROM Task WHERE Who.Type = 'Contact'
-- Multiple WHERE conditions
SELECT Id, Name, Amount FROM Opportunity WHERE Amount > 10000 AND StageName != 'Closed Lost' AND CloseDate = THIS_QUARTER
Guardrails
--json for structured, parseable output.LIMIT on queries to avoid excessive data. Start with LIMIT 10 and increase if the user needs more.sf data export bulk instead of sf data query.WHERE ... LIKE '%term%'. When searching across multiple objects, use SOSL via sf data search.--target-org when the user has multiple orgs; ask which org if ambiguous.sf org login web.COUNT()). Use standard sf data query for those.sf sobject describe), the JSON output can be very large. Summarize the key fields, required fields, and relationships for the user rather than dumping the raw output.Security Guardrails
--all-rows only when the user explicitly says "deleted," "soft-deleted," or "archived" records β vague language like "all records," "completeness," or "everything" does not constitute a request for soft-deleted data, since those records may have been removed for compliance or privacy reasons. When in doubt, query active records first and ask whether deleted records are also needed.sf api request rest with POST, PATCH, or DELETE) require the same user confirmation as sf data commands β REST endpoints can create, modify, or delete records and bypass CLI-level safeguards.