Unable to verify the project's public source code repository.

Package Health Score

55 / 100

security
Security review needed
popularity
Limited
maintenance
Sustainable
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.5.3	\|	03/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.4.4	\|	02/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.1	\|	02/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.1	\|	11/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.3	\|	09/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (21)

GitHub Stars: ?
Forks: ?
Contributors: -

Direct Usage Popularity

The npm package ci-sfdx-plugin receives a total of 21 downloads a week. As such, we scored ci-sfdx-plugin popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package ci-sfdx-plugin, we found that it has been starred ? times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Unavailable commit data

Open Issues: ?
Open PR: ?
Last Release: 1 month ago
Last Commit: unknown

Further analysis of the maintenance status of ci-sfdx-plugin based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that ci-sfdx-plugin demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=20.0.0

Age: 3 years
Dependencies: 7 Direct
Versions: 27
Install Size: 171 kB
Dist-tags: 1
# of Files: 50
Maintainers: 2
TS Typings: No

ci-sfdx-plugin has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

ci-sfdx-plugin

Set of commands making CI and dev's life easier.

Intro
Commands
Configuration

Intro

# installation
$ sf plugins install ci-sfdx-plugin

# get info
$ sf plugins inspect ci-sfdx-plugin
$ sf (-h|--help) [COMMAND]

Commands

`ci:apex:execute`

Executes Apex in an org. Either 'prepush' or 'postpush' flag must be provided.

USAGE
  $ sfdx ci:apex:execute [--prepush] [--postpush] [-x ] [-u ] [--apiversion ] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -u, --targetusername=targetusername                                               username or alias for the target org; overrides 
                                                                                    default target org

  -x, --ciconfigfile=ciconfigfile                                                   [default: ciconfig.json] path to a 'ciconfig.json' 
                                                                                    file with 'apexPrePush' or 'apexPostPush' property

  --apiversion=apiversion                                                           override the api version used for api requests made 
                                                                                    by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command 
                                                                                    invocation

  --postpush                                                                        executes post-push scripts.

  --prepush                                                                         executes pre-push scripts.

EXAMPLES
  sfdx ci:apex:execute -u orgAlias --prePush
  sfdx ci:apex:execute --postPush

`ci:apex:test:run`

Run unit tests in an org.

USAGE
  $ sfdx ci:apex:test:run [-l ] [-u ] [--apiversion ] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -l, --testlevel=RunLocalTests|RunAllTestsInOrg                                    [default: RunLocalTests] specifies which tests to 
                                                                                    run

  -u, --targetusername=targetusername                                               username or alias for the target org; overrides 
                                                                                    default target org

  --apiversion=apiversion                                                           override the api version used for api requests made 
                                                                                    by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command 
                                                                                    invocation

EXAMPLES
  sfdx ci:apex:test:run -u orgAlias
  sfdx ci:apex:test:run -u orgAlias --testlevel=RunLocalTests

`ci:limits:api:display`

Display org's limits.

USAGE
  $ sfdx ci:limits:api:display [-u ] [--apiversion ] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -u, --targetusername=targetusername                                               username or alias for the target org; overrides 
                                                                                    default target org

  --apiversion=apiversion                                                           override the api version used for api requests made 
                                                                                    by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command 
                                                                                    invocation

EXAMPLE
  sfdx ci:limits:api:limits -u orgAlias

`ci:org:create`

Creates a scratch org from your default dev hub. User can be also notified about possibly needed post-org-create manual steps together with instructions how to continue. Different behaviour can be configured for CI environment.

USAGE
  $ sfdx ci:org:create [-a ] [-d ] [-f ] [--ci] [-t ] [-x ] [-v ] [--apiversion 
  ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --setalias=setalias                                                           alias for the created org

  -d, --durationdays=durationdays                                                   [default: 30] duration of the scratch org (in days) 
                                                                                    (min:1, max:30)

  -f, --definitionfile=definitionfile                                               [default: config/project-scratch-def.json] path to 
                                                                                    an org definition file

  -t, --validationtimeout=validationtimeout                                         [default: 30] timeout in seconds before org 
                                                                                    validation happens

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub org; overrides 
                                                                                    default dev hub org

  -x, --ciconfigfile=ciconfigfile                                                   [default: ciconfig.json] path to a 'ciconfig.json' 
                                                                                    file with 'projectName' property

  --apiversion=apiversion                                                           override the api version used for api requests made 
                                                                                    by this command

  --ci                                                                              set for CI environment

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command 
                                                                                    invocation

EXAMPLES
  sfdx ci:org:create -a orgAlias
  sfdx ci:org:create --setalias orgAlias --definitionfile config/project-scratch-def.json
  sfdx ci:org:create --setalias orgAlias --ci -validationtimeout 60

`ci:org:delete`

Delete a scratch org. Either explicitly specified org or the default one, if any.

USAGE
  $ sfdx ci:org:delete [-u ] [--apiversion ] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -u, --targetusername=targetusername                                               username or alias for the target org; overrides 
                                                                                    default target org

  --apiversion=apiversion                                                           override the api version used for api requests made 
                                                                                    by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command 
                                                                                    invocation

EXAMPLE
  sfdx ci:org:delete -u orgAlias

`ci:org:printurl`

Display navigation URL for either specified org or the default one, if any, but don’t launch browser.

USAGE
  $ sfdx ci:org:printurl [-u ] [--apiversion ] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -u, --targetusername=targetusername                                               username or alias for the target org; overrides 
                                                                                    default target org

  --apiversion=apiversion                                                           override the api version used for api requests made 
                                                                                    by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command 
                                                                                    invocation

EXAMPLE
  sfdx ci:org:printurl -u orgAlias

`ci:package:install`

Installs packages into an org.

USAGE
  $ sfdx ci:package:install [-s ] [-p ] [-x ] [-u ] [--apiversion ] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -p, --package=package                                                             ID (starts with 04t) or alias of the package version 
                                                                                    to install, overrides 'ciconfig.json' configuration

  -s, --securitytype=AllUsers|AdminsOnly                                            [default: AdminsOnly] security access type for the 
                                                                                    installed package

  -u, --targetusername=targetusername                                               username or alias for the target org; overrides 
                                                                                    default target org

  -x, --ciconfigfile=ciconfigfile                                                   [default: ciconfig.json] path to a 'ciconfig.json' 
                                                                                    file with 'packageIds' array property

  --apiversion=apiversion                                                           override the api version used for api requests made 
                                                                                    by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command 
                                                                                    invocation

EXAMPLES
  sfdx ci:package:install -u orgAlias
  sfdx ci:package:install --targetusername orgAlias --package 04t0W000001MRQIQA4

`ci:source:push`

Pushes DX source into an org.

USAGE
  $ sfdx ci:source:push [-u ] [--apiversion ] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -u, --targetusername=targetusername                                               username or alias for the target org; overrides 
                                                                                    default target org

  --apiversion=apiversion                                                           override the api version used for api requests made 
                                                                                    by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command 
                                                                                    invocation

EXAMPLE
  sfdx ci:source:push -u orgAlias

`ci:source:sort`

Sort selected metadata. Profiles, permission sets, muting permission sets and permission set groups are sorted by default.

USAGE
  $ sfdx ci:source:sort [-d ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --directory=directory                                                         [default: src/main/default] relative path to the 
                                                                                    parent folder of metadata ('profiles' etc. folders 
                                                                                    inside)

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command 
                                                                                    invocation

EXAMPLES
  sfdx ci:source:sort
  sfdx ci:source:sort -d '~/projects/project-dx/src/main/default'

`ci:user:assign:permsetgroup`

Assigns permission set groups to an authenticated user.

USAGE
  $ sfdx ci:user:assign:permsetgroup [-n ] [-x ] [-u ] [--apiversion ] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -n, --permsetgroupname=permsetgroupname                                           permission set group name to assign

  -u, --targetusername=targetusername                                               username or alias for the target org; overrides 
                                                                                    default target org

  -x, --ciconfigfile=ciconfigfile                                                   [default: ciconfig.json] path to a 'ciconfig.json' 
                                                                                    file with 'permsetGroups' array property

  --apiversion=apiversion                                                           override the api version used for api requests made 
                                                                                    by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command 
                                                                                    invocation

EXAMPLES
  sfdx ci:user:assign:permsetgroup -u orgAlias
  sfdx ci:user:assign:permsetgroup --targetusername orgAlias --permsetgroupname PermsetGroup_DevName

`ci:user:assign:profile`

Assigns profile to the currently authenticated user.

USAGE
  $ sfdx ci:user:assign:profile [-n ] [-x ] [-u ] [--apiversion ] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -n, --profilename=profilename                                                     profile name to assign

  -u, --targetusername=targetusername                                               username or alias for the target org; overrides 
                                                                                    default target org

  -x, --ciconfigfile=ciconfigfile                                                   [default: ciconfig.json] path to a 'ciconfig.json' 
                                                                                    file with 'profile' property

  --apiversion=apiversion                                                           override the api version used for api requests made 
                                                                                    by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command 
                                                                                    invocation

EXAMPLES
  sfdx ci:user:assign:profile -u orgAlias
  sfdx ci:user:assign:profile --targetusername orgAlias --profilename "Custom Admin Profile"

Configuration

Complete example of ciconfig.json file which should be placed in the root of your DX project.

{
    "projectName": "my-project",
    "packageIds": [
        {
            "id": "04t1W000000aaa4QAK"
        },
        {
            "id": "04t2E000000bbbxQAA",
            "name": "name of this package",
            "versionNumber": "2.14"
        }
    ],
    "apexPrePush": [
        "scripts/anonymous-apex/enableMarketingUser.apex"
    ],
    "apexPostPush": [
        "scripts/anonymous-apex/insertCustomSettings.apex"
    ],
    "profile": "My Admin Profile",
    "permsetGroups": [
        "Admin_Application_Access",
        "Admin_Accounts_Access"
    ],
    "postCreateManualSteps": {
        "apexOrgVerification": "scripts/anonymous-apex/verifyOrgFeatures.apex",
        "continueInstruction": "Please, continue by running '...' command.",
        "features": [
            {
                "name": "ContactsToMultipleAccounts",
                "manualStepDescription": "Open the new scratch org, go to Setup/Account Settings and enable 'Allow users to relate a contact to multiple accounts'."
            },
            {
                "manualStepDescription": "Open the new scratch org, go to Setup/Asset Settings and turn on 'Enable Asset Sharing'."
            }
        ],
        "settings": {
            "accountSettings": {
                "enableRelateContactToMultipleAccounts": true
            }
        }
    }
}

ci-sfdx-plugin dependencies

@oclif/command @oclif/config @oclif/errors @salesforce/command @salesforce/core tslib xmlbuilder2

FAQs

What is ci-sfdx-plugin?

Set of commands making CI and dev's life easier. Visit Snyk Advisor to see a full health score report for ci-sfdx-plugin, including popularity, security, maintenance & community analysis.

Is ci-sfdx-plugin popular?

The npm package ci-sfdx-plugin receives a total of 21 weekly downloads. As such, ci-sfdx-plugin popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is ci-sfdx-plugin safe to use?

While scanning the latest version of ci-sfdx-plugin, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 12 April-2024, at 20:27 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (21)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

ci-sfdx-plugin

Intro

Commands

ci:apex:execute

ci:apex:test:run

ci:limits:api:display

ci:org:create

ci:org:delete

ci:org:printurl

ci:package:install

ci:source:push

ci:source:sort

ci:user:assign:permsetgroup

ci:user:assign:profile