Get Started

Requirements

Node.js ^22.13.0, ^24.0.0, or ^26.0.0
Most functions take an authenticated @salesforce/core Connection — this library doesn’t handle org auth for you (except simply-core’s authenticateClientCredentials, which builds one from a Connected App’s client-credentials flow). If you already have an sf-authenticated org, resolve a Connection from it with @salesforce/core’s AuthInfo/Org APIs.

Install

Each package is independent and published separately — install only what you need:

npm install @simplysf/simply-core
npm install @simplysf/simply-report
npm install @simplysf/simply-aep-core
npm install @simplysf/simply-document-core
npm install @simplysf/simply-apex-core
npm install @simplysf/simply-permissions-core
npm install @simplysf/simply-sobject-core
npm install @simplysf/simply-community-core
npm install @simplysf/simply-data-core
npm install @simplysf/simply-package-core
npm install @simplysf/simply-schema-core
npm install @simplysf/simply-project-setup-core
npm install @simplysf/simply-cicd-core

Package	What it’s for
`simply-core`	Querying, bulk export, CSV, and `sfdx-project.json` utilities
`simply-report`	Shared HTML report scaffolding
`simply-aep-core`	Apex Enterprise Patterns (fflib, force-di, AT4DX) binding scan and resolution logic
`simply-document-core`	Confluence-storage-format change report and technical design document rendering
`simply-apex-core`	Apex execute, log-purge, and trace-flag logic
`simply-permissions-core`	Permission set XML and permissions report rendering
`simply-sobject-core`	Field history object derivation/filtering and relationship-field discovery
`simply-community-core`	Community publish/deploy/domain-verification logic and site-file discovery
`simply-data-core`	Content Version upload/download and CSV row counting logic
`simply-package-core`	Package/package-version alias resolution, `sfdx-project.json` dependency management, and Dev Hub version lookup
`simply-schema-core`	sObject schema generation (CSV/Excel parsing, field/object normalization) and interactive schema-report rendering
`simply-project-setup-core`	Salesforce DX project file/dependency standardization engine (template packs, `.gitignore` composition, `package.json` scripts/dependency merging)
`simply-cicd-core`	ALM issue linking (Jira, GitLab Issues) and VCS API clients (GitHub, GitLab)

Next steps

Each package has its own guide with real usage examples, and a full API reference generated from its TypeScript source: