Skip to main content

Frictionless Salesforce Agent Skill for Codex, Claude Code, and GitHub Copilot.

Project description

Salesforce Agent Optimizer

English | Italiano | Espanol | Simplified Chinese

Salesforce Agent Optimizer is an MIT-licensed sfao CLI and agent skill for Codex, Claude Code, and GitHub Copilot.

Current version: 2.0.0

It helps AI agents work on Salesforce projects with Salesforce-first planning, configuration before custom code, minimal reversible changes, local Knowledge, token-efficient Salesforce CLI usage, least-privilege checks, explicit org aliases, package.xml awareness, and destructive-operation guardrails.

Quick Start

uv tool install salesforce-agent-optimizer
sfao install
sfao knowledge init --project-root .
sfao doctor

Use uv tool install or python -m pipx install for isolated CLI installs. Plain python -m pip install also works when you intentionally want sfao in the active Python environment.

Install

uv tool install salesforce-agent-optimizer
sfao install
sfao validate

Alternatives:

python -m pipx install salesforce-agent-optimizer
python -m pip install git+https://github.com/lucabenedettini/salesforce-ai-agent-optimizer.git
uv tool install git+https://github.com/lucabenedettini/salesforce-ai-agent-optimizer.git

sfao install installs project-scoped adapters for all supported agents. Use sfao install --user --platform all only when you want a user-scoped Codex/Claude install.

Main Commands

sfao version
sfao install
sfao install --project --platform all
sfao update --project --platform all
sfao uninstall --project --platform all --yes
sfao doctor
sfao doctor --verbose
sfao validate
sfao validate --json
sfao knowledge init --project-root .
sfao knowledge refresh --project-root .
sfao knowledge doctor --project-root .
sfao version-context scaffold
sfao version-context update
sfao version-context validate

For org operations the agent must ask for an explicit org alias. Production orgs are read-only through the skill guardrails.

Agent Workflow

Installed agents must follow the same visible phases for information requests, bugfixes, implementation, architecture, reviews, org inspection, and release work:

  1. Request review
  2. Planning evidence
  3. Approval
  4. Implementation
  5. Validation
  6. Completion

During each phase the agent must state the tool or command it is using or planning. For Salesforce CLI access it must show the compact sfao, scripts/sf_agent_cli.py, or official sf command shape with aliases and secrets redacted.

Safety

  • Prefer Salesforce configuration, Flow, permission sets, UI API/LDS, named credentials, and managed packages before custom code.
  • Inspect local Knowledge before changing Salesforce metadata.
  • Apply least privilege before access, sharing, UI, package, integration, or automation changes.
  • Do not retrieve or parse all org metadata unless the user asks for broad analysis or the task requires it.
  • Never delete data or metadata without separate explicit approval for the exact scope.
  • Never expose Salesforce secrets or customer data without separate explicit approval for the exact scope.
  • Generate package.xml for added or modified metadata.
  • Ask whether to generate release notes, technical specifications, impact assessment, user testing, and manual procedures after implementation.

Update

uv tool upgrade salesforce-agent-optimizer
sfao update --project --platform all
sfao doctor

Alternatives:

python -m pipx upgrade salesforce-agent-optimizer
python -m pip install --upgrade salesforce-agent-optimizer

Uninstall

sfao uninstall --project --platform all --yes
uv tool uninstall salesforce-agent-optimizer

Alternative:

python -m pipx uninstall salesforce-agent-optimizer

More Documentation

Detailed installation, command behavior, troubleshooting, publishing, release, and versioning docs live in docs/wiki/.

License

MIT. Anyone can use, copy, modify, distribute, and fork this repository under the terms of LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

salesforce_agent_optimizer-2.0.0.tar.gz (155.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

salesforce_agent_optimizer-2.0.0-py3-none-any.whl (210.5 kB view details)

Uploaded Python 3

File details

Details for the file salesforce_agent_optimizer-2.0.0.tar.gz.

File metadata

File hashes

Hashes for salesforce_agent_optimizer-2.0.0.tar.gz
Algorithm Hash digest
SHA256 9508d160cc12cda335a8e59b9a2bb001bf7494b65c807f5ffaedf44c133b42bb
MD5 1bf1a522a1e05e4c4b6f80dd7c43d37f
BLAKE2b-256 8ef898aa6f05ace7dd9adde264510216e9ad76944eaf054810991a20743b9d05

See more details on using hashes here.

Provenance

The following attestation bundles were made for salesforce_agent_optimizer-2.0.0.tar.gz:

Publisher: release.yml on lucabenedettini/salesforce-ai-agent-optimizer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file salesforce_agent_optimizer-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for salesforce_agent_optimizer-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1c4e3c7592380ad18418683e41de80bb6e5a36877b7a4c9f378752f3b1159487
MD5 351b176675eb1d8a2f67635d9a4bc27d
BLAKE2b-256 7b7b939f01a970f1c9a43e6665dbc040ebb11679871d952fe1fc8499e3c2adfa

See more details on using hashes here.

Provenance

The following attestation bundles were made for salesforce_agent_optimizer-2.0.0-py3-none-any.whl:

Publisher: release.yml on lucabenedettini/salesforce-ai-agent-optimizer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page