# Sf Cli Reference

> >-

- **Type:** Skill
- **Install:** `agentstack add skill-jiten-singh-shahi-salesforce-claude-code-sf-cli-reference`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [jiten-singh-shahi](https://agentstack.voostack.com/s/jiten-singh-shahi)
- **Installs:** 0
- **Category:** [Cloud & Infrastructure](https://agentstack.voostack.com/c/cloud-infrastructure)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [jiten-singh-shahi](https://github.com/jiten-singh-shahi)
- **Source:** https://github.com/jiten-singh-shahi/salesforce-claude-code/tree/main/.cursor/skills/sf-cli-reference
- **Website:** https://www.npmjs.com/package/scc-universal

## Install

```sh
agentstack add skill-jiten-singh-shahi-salesforce-claude-code-sf-cli-reference
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# SF CLI Command Reference

Reference: @../_reference/SF_CLI_COMMANDS.md

## When to Use

- When you need to find the right `sf` command for a Salesforce task
- When constructing CLI commands with correct flags and syntax
- When choosing between similar commands (e.g., deploy start vs deploy validate)
- When setting up org authentication (web, jwt, sfdx-url)
- When running Apex tests or querying data from the command line
- When managing scratch orgs, packages, or metadata via CLI

---

## Command Decision Tree

### Authenticate to an Org

| Scenario | Command | Key Flags |
|---|---|---|
| Interactive browser login | `sf org login web` | `--alias`, `--set-default` |
| CI/CD non-interactive login | `sf org login jwt` | `--client-id`, `--jwt-key-file`, `--username` |
| Auth URL from file | `sf org login sfdx-url` | `--sfdx-url-file` |
| Log out of an org | `sf org logout` | `--target-org`, `--no-prompt` |
| List all connected orgs | `sf org list` | `--all` |
| Open org in browser | `sf org open` | `--target-org`, `--path` |
| Display org details | `sf org display` | `--target-org`, `--verbose` |

### Deploy or Retrieve Source

| Scenario | Command | Key Flags |
|---|---|---|
| Deploy source directory | `sf project deploy start` | `--source-dir`, `--target-org` |
| Deploy with manifest | `sf project deploy start` | `--manifest`, `--target-org` |
| Deploy specific metadata | `sf project deploy start` | `--metadata "ApexClass:MyClass"` |
| Validate without deploying | `sf project deploy validate` | `--test-level`, `--target-org` |
| Quick deploy after validation | `sf project deploy quick` | `--job-id`, `--target-org` |
| Check deploy status | `sf project deploy report` | `--job-id` |
| Resume failed deploy | `sf project deploy resume` | `--job-id` |
| Cancel in-progress deploy | `sf project deploy cancel` | `--job-id` |
| Retrieve from org | `sf project retrieve start` | `--source-dir`, `--target-org` |
| Retrieve by manifest | `sf project retrieve start` | `--manifest` |
| Preview retrieval | `sf project retrieve preview` | `--target-org` |
| Generate manifest | `sf project generate manifest` | `--source-dir`, `--output-dir` |
| Convert source to mdapi | `sf project convert source` | `--root-dir`, `--output-dir` |
| Convert mdapi to source | `sf project convert mdapi` | `--root-dir`, `--output-dir` |
| Create new project | `sf project generate` | `--name`, `--template` |

### Run Apex Code and Tests

| Scenario | Command | Key Flags |
|---|---|---|
| Execute anonymous Apex | `sf apex run` | `--file`, `--target-org` |
| Run all local tests | `sf apex run test` | `--test-level RunLocalTests` |
| Run specific test classes | `sf apex run test` | `--class-names "MyTest,OtherTest"` |
| Run specific test methods | `sf apex run test` | `--tests "MyTest.testMethod"` |
| Run tests with coverage | `sf apex run test` | `--code-coverage`, `--output-dir` |
| Run test suite | `sf apex run test` | `--suite-names "MySuite"` |
| Stream debug logs live | `sf apex tail log` | `--target-org`, `--debug-level` |
| Get a specific log | `sf apex get log` | `--log-id` |
| List recent logs | `sf apex list log` | `--target-org` |

### Work with Data

| Scenario | Command | Key Flags |
|---|---|---|
| Run SOQL query | `sf data query` | `--query`, `--target-org` |
| Run SOQL from file | `sf data query` | `--file`, `--result-format` |
| Bulk SOQL query | `sf data query` | `--query`, `--bulk`, `--wait` |
| Run SOSL search | `sf data search` | `--query` |
| Create a record | `sf data create record` | `--sobject`, `--values` |
| Update a record | `sf data update record` | `--sobject`, `--record-id`, `--values` |
| Delete a record | `sf data delete record` | `--sobject`, `--record-id` |
| Bulk upsert from CSV | `sf data upsert bulk` | `--file`, `--sobject`, `--external-id` |
| Bulk delete from CSV | `sf data delete bulk` | `--file`, `--sobject` |
| Export data as tree | `sf data export tree` | `--query`, `--plan` |
| Import tree data | `sf data import tree` | `--plan`, `--target-org` |

### Manage Scratch Orgs and Sandboxes

| Scenario | Command | Key Flags |
|---|---|---|
| Create scratch org | `sf org create scratch` | `--definition-file`, `--alias`, `--duration-days` |
| Delete scratch org | `sf org delete scratch` | `--target-org`, `--no-prompt` |
| Create sandbox | `sf org create sandbox` | `--name`, `--definition-file`, `--alias` |
| Clone sandbox | `sf org create sandbox` | `--clone`, `--name` |
| Delete sandbox | `sf org delete sandbox` | `--target-org`, `--no-prompt` |
| Resume sandbox creation | `sf org resume sandbox` | `--name`, `--target-org` |
| Assign permission set | `sf org assign permset` | `--name`, `--target-org` |
| Create user | `sf org create user` | `--definition-file`, `--target-org` |

### Manage Packages

| Scenario | Command | Key Flags |
|---|---|---|
| Create package | `sf package create` | `--name`, `--package-type`, `--path` |
| Create version | `sf package version create` | `--package`, `--installation-key`, `--code-coverage` |
| Promote version | `sf package version promote` | `--package` |
| Install package | `sf package install` | `--package`, `--target-org` |
| Uninstall package | `sf package uninstall` | `--package`, `--target-org` |
| List versions | `sf package version list` | `--packages`, `--verbose` |
| List installed | `sf package installed list` | `--target-org` |

### Work with Agentforce / AI Agents

| Scenario | Command | Key Flags |
|---|---|---|
| Create agent | `sf agent create` | `--target-org` |
| Generate agent spec | `sf agent generate spec` | `--output-dir` |
| Generate agent tests | `sf agent generate test` | `--spec-file`, `--output-dir` |
| Run agent tests | `sf agent test run` | `--name`, `--target-org` |
| Preview agent | `sf agent preview` | `--name`, `--target-org` |
| Activate agent | `sf agent activate` | `--target-org` |
| Deactivate agent | `sf agent deactivate` | `--target-org` |

> Note: `sf agent` commands are actively evolving. Run `sf agent  --help` for the latest flags.

### Generate Code from Templates

| Scenario | Command | Key Flags |
|---|---|---|
| Generate Apex class | `sf apex generate class` | `--name`, `--output-dir`, `--template` |
| Generate Apex trigger | `sf apex generate trigger` | `--name`, `--sobject`, `--output-dir` |
| Generate LWC | `sf lightning generate component` | `--name`, `--type lwc` |
| Generate Aura component | `sf lightning generate component` | `--name`, `--type aura` |
| Generate Lightning event | `sf lightning generate event` | `--name`, `--output-dir` |
| Generate SObject | `sf schema generate sobject` | `--label`, `--output-dir` |
| Generate field | `sf schema generate field` | `--label`, `--object` |
| Generate platform event | `sf schema generate platformevent` | `--label`, `--output-dir` |
| Generate project | `sf project generate` | `--name`, `--template` |

### Other Utilities

| Scenario | Command | Key Flags |
|---|---|---|
| Set default org | `sf config set` | `target-org=myOrg` |
| List config values | `sf config list` | |
| Set alias | `sf alias set` | `myAlias=user@org.com` |
| Describe SObject | `sf sobject describe` | `--sobject`, `--target-org` |
| List SObjects | `sf sobject list` | `--sobject-type`, `--target-org` |
| REST API request | `sf api request rest` | (URL path), `--method`, `--body` |
| GraphQL request | `sf api request graphql` | `--body` |
| Run Flow tests | `sf logic run test` | `--target-org` |
| Diagnose CLI issues | `sf doctor` | |
| Install plugin | `sf plugins install` | (plugin name) |
| Update CLI | `sf update` | |
| Show release notes | `sf info releasenotes display` | |

---

## Workflow Patterns

### Authentication + Deploy

```bash
# Login and deploy source
sf org login web --alias myOrg --set-default
sf project deploy start --source-dir force-app --target-org myOrg --wait 30
```

### CI/CD: Validate Then Quick Deploy

```bash
# Authenticate in CI
sf org login jwt \
    --client-id $SF_CLIENT_ID \
    --jwt-key-file server.key \
    --username $SF_USERNAME \
    --alias prod

# Validate (runs tests without committing)
sf project deploy validate \
    --source-dir force-app \
    --test-level RunLocalTests \
    --target-org prod \
    --wait 60

# Quick deploy after successful validation (use job ID from validation output)
sf project deploy quick --job-id $JOB_ID --target-org prod
```

### Scratch Org Development Cycle

```bash
# Create scratch org
sf org create scratch \
    --definition-file config/project-scratch-def.json \
    --alias dev \
    --duration-days 7 \
    --set-default

# Push source and assign permissions
sf project deploy start --source-dir force-app --target-org dev
sf org assign permset --name MyPermSet --target-org dev

# Import sample data
sf data import tree --plan data/sample-data-plan.json --target-org dev

# Run tests
sf apex run test --test-level RunLocalTests --target-org dev --code-coverage

# Clean up
sf org delete scratch --target-org dev --no-prompt
```

---

## Related

- **Skill**: `sf-deployment` -- detailed deployment strategies and error resolution
- **Skill**: `sf-devops-ci-cd` -- CI/CD pipeline setup with GitHub Actions
- **Skill**: `sf-debugging` -- debug log setup and analysis with CLI commands
- **Skill**: `sf-metadata-management` -- metadata types and source tracking
- **Skill**: `sf-docs-lookup` -- web search for official Salesforce documentation

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [jiten-singh-shahi](https://github.com/jiten-singh-shahi)
- **Source:** [jiten-singh-shahi/salesforce-claude-code](https://github.com/jiten-singh-shahi/salesforce-claude-code)
- **License:** MIT
- **Homepage:** https://www.npmjs.com/package/scc-universal

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-jiten-singh-shahi-salesforce-claude-code-sf-cli-reference
- Seller: https://agentstack.voostack.com/s/jiten-singh-shahi
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.