@brightfox/plugin-brightfox

Brightfox plugin for the Salesforce CLI (sf). Adds the bf command topic for Brightfox's Salesforce DX workflow: a central package registry, scratch-org and project scaffolding, project package-dependency management, permission tooling, data export, and Apex codegen from OpenAPI specs.

All commands live under the bf topic and follow standard sf conventions (--json, --target-org, --api-version, --flags-dir).

Requirements

• Node.js >= 18
• Salesforce CLI (sf)

Install

sf plugins install @brightfox/plugin-brightfox

Verify:

sf plugins

Command overview

Package registry — bf package

Manage packages and versions in the Brightfox package repository.

| Command | Description | | ----------------------------------- | ----------------------------------------------------------------------- | | bf package list | List all packages in the repository. | | bf package detail | Show details of the latest version of a package. | | bf package register | Register a new package in the repository. | | bf package install | Install the latest version of packages from the repository into an org. | | bf package version list | List package versions in the repository. | | bf package version register | Register a package version in the repository. | | bf package version beta create | Create a new beta package version. | | bf package version release create | Create a new released package version. |

Org & project — bf org, bf project

| Command | Description | | --------------------------------------- | --------------------------------------------------------- | | bf org setup | Set up a new scratch org. | | bf project create | Scaffold a new Brightfox project. | | bf project data export | Export the results of a SOQL query to a CSV or XLSX file. | | bf project generate manifest retrieve | Retrieve Salesforce metadata from a project. |

Project package dependencies — bf project package

Manage package aliases in the project configuration.

| Command | Description | | ----------------------------- | -------------------------------------------------------- | | bf project package add | Add package aliases to the project JSON. | | bf project package remove | Remove package aliases from the project JSON. | | bf project package check | Check whether package aliases are on the latest version. | | bf project package upgrade | Upgrade all package aliases to the latest versions. | | bf project package install | Install packages from the project configuration. | | bf project package retrieve | Retrieve installed packages from an org. |

Permissions — bf permissions

| Command | Description | | ------------------------------- | ------------------------------------------------------------------------------ | | bf permissions minify | Reformat permission set, permission set group, and profile XML files in place. | | bf permissions perm-set check | List permission sets that grant (or omit) given user permissions. | | bf permissions profile check | List profiles that grant (or omit) given user permissions. | | bf permissions profile update | Enable or disable a user permission across matching profiles. |

OpenAPI codegen — bf openapi

| Command | Description | | ---------------------------- | --------------------------------------------------------------------------- | | bf openapi client generate | Generate Apex client classes from an OpenAPI specification. | | bf openapi server generate | Generate Apex server (REST resource) classes from an OpenAPI specification. |

Run any command with --help for full flags and examples:

sf bf package list --help

Development

Requires yarn.

# Clone and install
git clone [email protected]:7dots_eu/plugin-brightfox.git
cd plugin-brightfox
yarn && yarn build

Run against the local build without linking:

./bin/dev.js bf package list

Or link into the sf CLI to run from anywhere:

sf plugins link .
sf plugins   # verify

Scripts

| Script | Purpose | | ---------------- | ----------------------------------------------------------------------------- | | yarn build | Compile and lint. | | yarn compile | TypeScript compile only. | | yarn lint | Run ESLint. | | yarn format | Format with Prettier. | | yarn test | Full test suite (unit, lint, command reference, deprecation & schema checks). | | yarn test:only | Unit tests only. | | yarn test:nuts | Non-unit (integration) tests. |

Contributing

1. Read the Code of Conduct.
2. Fork the repo and create a topic branch.
3. Make your change and add tests — aim for high coverage on new code.
4. Open a pull request.

Issues

Report issues on the repository tracker.

Security

See SECURITY.md.

License

Apache-2.0. See LICENSE.txt.