sf-settings
v0.1.1
Published
Salesforce Settings CLI - manage org settings via terminal
Maintainers
Readme
sf-settings
Salesforce Settings CLI — manage org settings from your terminal.
Install
npm install -g sf-settingsThe CLI command is sf-settings.
Prerequisites
- Node.js >= 20
- Salesforce CLI (
sf) installed and authenticated
Usage
List all settings types
sf-settings listShows all 42 settings types grouped by category (Security & Access, Sales, Service, etc.).
Filter by category
sf-settings list -c "Security & Access"
sf-settings list -c "Sales"
sf-settings list -c "Service"Available categories:
Security & AccessChatter & SocialSalesServiceEmailAI & EinsteinMobile & ChannelsOrganizationUsersDevelopmentData
Get settings
# Human-readable output
sf-settings get SecuritySettings -o myorg
# JSON output
sf-settings get ChatterSettings -o myorg --jsonRun sf-settings list first to see all available settings type names.
Org info
sf-settings org info -o myorg
sf-settings org info --list # List all authenticated orgsSupported Settings (42 types)
| Category | Types | |---|---| | Security & Access | SecuritySettings, PlatformEncryptionSettings, FileUploadAndDownloadSecurity | | Chatter & Social | ChatterSettings, CommunitiesSettings, SocialCustomerServiceSettings | | Sales | OpportunitySettings, QuoteSettings, SalesSettings, Territory2Settings, ForecastingSettings, ActivitiesSettings, PathAssistantSettings | | Service | CaseSettings, EntitlementSettings, KnowledgeSettings, LiveAgentSettings, OmniChannelSettings, IdeasSettings, MacroSettings | | Email | EmailAdministrationSettings, EmailToCaseSettings, WebToCaseSettings, WebToLeadSettings | | AI & Einstein | RecommendationSettings, MlDomainClassification/Clustering/Recommendation/Regression/SimilaritySettings, IoTSettings | | Mobile & Channels | MobileSettings, VoiceSettings | | Organization | OrgPreferenceSettings, NameSettings, SearchSettings, PicklistSettings, WorkDotComSettings | | Users | UserManagementSettings | | Development | ApexSettings | | Data | ExternalDataSourceSettings |
License
MIT License
This project is open source and available under the MIT License.
What this means for you:
- Free to use: Use this tool for personal or commercial projects without any cost
- Free to modify: Fork, modify, and customize the code to fit your needs
- Free to distribute: Share the tool with your team or redistribute it
- No warranty: This software is provided "as is" without warranties of any kind
Limitations:
- The license does not provide any warranty or liability protection
- You must include the original copyright notice and license text when distributing
- The authors are not liable for any claims, damages, or other liability arising from use of this software
See the LICENSE file for the full legal text.
Contributing
Contributions are welcome! Feel free to:
- Report bugs or request features via GitHub issues
- Submit pull requests with improvements
- Share feedback and suggestions
Disclaimer
This is an independent tool and is not officially affiliated with or endorsed by Salesforce, Inc. Use of this tool with Salesforce APIs is subject to Salesforce's terms of service and API usage limits.
