@kitalive/sfdx-plugin


Install

``
sf plugins install @kitalive/sfdx-plugin
`

Usage


`sh-session
$ npm install -g @kitalive/sfdx-plugin
$ sf COMMAND
running command...
$ sf (--version)
@kitalive/sfdx-plugin/1.0.3 darwin-arm64 node-v22.17.1
$ sf --help [COMMAND]
USAGE
$ sf COMMAND
...
`


Commands


* sf kit data bulk delete
* sf kit data bulk insert
* sf kit data bulk query
* sf kit data bulk update
* sf kit data bulk upsert
* sf kit data csv convert
* sf kit graphql editor
* sf kit layout assignments deploy
* sf kit layout assignments retrieve
* sf kit metadata dependencies
* sf kit object fields describe
* sf kit object fields setup
* sf kit script
* sf kit script execute

sf kit data bulk delete

Bulk delete records by SOQL select query.

`
USAGE
$ sf kit data bulk delete -q -o [--json] [--flags-dir ] [--hard] [--concurrency-mode
Serial|Parallel] [-s ] [-w ] [--api-version ]

FLAGS
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
-q, --query= (required) SOQL query to delete
-s, --batch-size= [default: 10000] The batch size of the job
-w, --wait= The number of minutes to wait for the command to complete before displaying the
results
--api-version= Override the api version used for api requests made by this command
--concurrency-mode= [default: Parallel] The concurrency mode (Parallel or Serial) for the job

--hard Perform a hard delete

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

EXAMPLES
Delete Opportunity records with CloseDate older than 2 years:

$ sf kit data bulk delete -q "SELECT Id FROM Opportunity WHERE CloseDate < LAST_N_YEARS:2"
`

_See code: src/commands/kit/data/bulk/delete.ts_

sf kit data bulk insert

For information about CSV file formats, see Prepare CSV Files in the Bulk API Developer Guide.

`
USAGE
$ sf kit data bulk insert -s -f -o [-r ] [-e ] [-d ] [-q ]
[--skip-lines ] [--trim] [-m ] [-c ] [--set-null] [--convert-only] [--concurrency-mode
Serial|Parallel] [--assignment-rule-id ] [--batch-size ] [-w ] [--api-version ]

FLAGS
-c, --converter= The path of the script to convert CSV rows
-d, --delimiter= [default: ,] The input CSV file delimiter
-e, --encoding= [default: utf8] The input CSV file encoding
-f, --csv-file= (required) The CSV file path that defines the records to insert
-m, --mapping= The path of the JSON file that defines CSV column mappings
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
-q, --quote= [default: "] The input CSV file quote character
-r, --result-file= The CSV file path for writing the insert results
-s, --sobject= (required) The SObject name to insert
-w, --wait= The number of minutes to wait for the command to complete before displaying the
results
--api-version= Override the api version used for api requests made by this command
--assignment-rule-id= The ID of a specific assignment rule to run for a case or a lead
--batch-size= [default: 10000] The batch size of the job
--concurrency-mode= [default: Parallel] The concurrency mode (Parallel or Serial) for the job

--convert-only Output converted.csv file and skip insert for debugging
--set-null Set blank values as null values during insert operations (default: empty field
values are ignored)
--skip-lines= The number of lines to skip
--trim Trim all white space from columns

DESCRIPTION
For information about CSV file formats, see Prepare CSV
Files in
the Bulk API Developer Guide.

EXAMPLES
Insert Account records with mapping.json:

$ sf kit data bulk insert -o Account -f ./path/to/Account.csv -m ./path/to/mapping.json

%s MyObject__c records with convert.js:

$ sf kit data bulk insert -o MyObject__c -f ./path/to/MyObject__c.csv -c ./path/to/convert.js -w 10
`

_See code: src/commands/kit/data/bulk/insert.ts_

sf kit data bulk query

Bulk query records.

`
USAGE
$ sf kit data bulk query -q -o [--json] [--flags-dir ] [-f ] [--all] [-w ]
[--api-version ]

FLAGS
-f, --csv-file= [default: standard output] Output csv file
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
-q, --query= (required) SOQL query to export
-w, --wait= [default: 5] The number of minutes to wait for the command to complete before displaying
the results
--all include deleted or archived records
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

EXAMPLES
Query Account records and save to specified path:

$ sf kit data bulk query -q "SELECT Id, Name FROM Account" -f ./path/to/Account.csv
`

_See code: src/commands/kit/data/bulk/query.ts_

sf kit data bulk update

For information about CSV file formats, see Prepare CSV Files in the Bulk API Developer Guide.

`
USAGE
$ sf kit data bulk update -s -f -o [-r ] [-e ] [-d ] [-q ]
[--skip-lines ] [--trim] [-m ] [-c ] [--set-null] [--convert-only] [--concurrency-mode
Serial|Parallel] [--assignment-rule-id ] [--batch-size ] [-w ] [--api-version ]

FLAGS
-c, --converter= The path of the script to convert CSV rows
-d, --delimiter= [default: ,] The input CSV file delimiter
-e, --encoding= [default: utf8] The input CSV file encoding
-f, --csv-file= (required) The CSV file path that defines the records to update
-m, --mapping= The path of the JSON file that defines CSV column mappings
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
-q, --quote= [default: "] The input CSV file quote character
-r, --result-file= The CSV file path for writing the update results
-s, --sobject= (required) The SObject name to update
-w, --wait= The number of minutes to wait for the command to complete before displaying the
results
--api-version= Override the api version used for api requests made by this command
--assignment-rule-id= The ID of a specific assignment rule to run for a case or a lead
--batch-size= [default: 10000] The batch size of the job
--concurrency-mode= [default: Parallel] The concurrency mode (Parallel or Serial) for the job

--convert-only Output converted.csv file and skip update for debugging
--set-null Set blank values as null values during update operations (default: empty field
values are ignored)
--skip-lines= The number of lines to skip
--trim Trim all white space from columns

DESCRIPTION
For information about CSV file formats, see Prepare CSV
Files in
the Bulk API Developer Guide.

EXAMPLES
Update Account records with mapping.json:

$ sf kit data bulk update -o Account -f ./path/to/Account.csv -m ./path/to/mapping.json

%s MyObject__c records with convert.js:

$ sf kit data bulk update -o MyObject__c -f ./path/to/MyObject__c.csv -c ./path/to/convert.js -w 10
`

_See code: src/commands/kit/data/bulk/update.ts_

sf kit data bulk upsert

For information about CSV file formats, see Prepare CSV Files in the Bulk API Developer Guide.

`
USAGE
$ sf kit data bulk upsert -s -f -o -i [-r ] [-e ] [-d ] [-q
] [--skip-lines ] [--trim] [-m ] [-c ] [--set-null] [--convert-only] [--concurrency-mode
Serial|Parallel] [--assignment-rule-id ] [--batch-size ] [-w ] [--api-version ]

FLAGS
-c, --converter= The path of the script to convert CSV rows
-d, --delimiter= [default: ,] The input CSV file delimiter
-e, --encoding= [default: utf8] The input CSV file encoding
-f, --csv-file= (required) The CSV file path that defines the records to upsert
-i, --external-id= (required) [default: Id] The column name of the external ID
-m, --mapping= The path of the JSON file that defines CSV column mappings
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
-q, --quote= [default: "] The input CSV file quote character
-r, --result-file= The CSV file path for writing the upsert results
-s, --sobject= (required) The SObject name to upsert
-w, --wait= The number of minutes to wait for the command to complete before displaying the
results
--api-version= Override the api version used for api requests made by this command
--assignment-rule-id= The ID of a specific assignment rule to run for a case or a lead
--batch-size= [default: 10000] The batch size of the job
--concurrency-mode= [default: Parallel] The concurrency mode (Parallel or Serial) for the job

--convert-only Output converted.csv file and skip upsert for debugging
--set-null Set blank values as null values during upsert operations (default: empty field
values are ignored)
--skip-lines= The number of lines to skip
--trim Trim all white space from columns

DESCRIPTION
For information about CSV file formats, see Prepare CSV
Files in
the Bulk API Developer Guide.

EXAMPLES
Upsert Account records with mapping.json:

$ sf kit data bulk upsert -o Account -f ./path/to/Account.csv -m ./path/to/mapping.json

Upsert MyObject__c with convert.js and external ID

$ sf kit data bulk upsert -o MyObject__c -f ./path/to/MyObject__c.csv -c ./path/to/convert.js -i MyExternalId__c \
-w 10
`

_See code: src/commands/kit/data/bulk/upsert.ts_

sf kit data csv convert

Convert CSV data using column mapping file or Node.js script.

`
USAGE
$ sf kit data csv convert [--json] [--flags-dir ] [-i ] [-f ] [-e ] [-d ] [-q
] [--skip-lines ] [--trim] [-m ] [-c ] [-o ] [--api-version ]

FLAGS
-c, --converter= The path of the script to convert CSV rows
-d, --delimiter= [default: ,] The input CSV file delimiter
-e, --encoding= [default: utf8] The input CSV file encoding
-f, --output= [default: standard output] The path of the output CSV file
-i, --input= [default: standard input] The path of the input CSV file
-m, --mapping= The path of the JSON file that defines CSV column mappings
-o, --target-org= Username or alias of the target org.
-q, --quote= [default: "] The input CSV file quote character
--api-version= Override the api version used for api requests made by this command
--skip-lines= The number of lines to skip
--trim Trim all white space from columns

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

EXAMPLES
Convert csv file using mapping file and output to standard output:

$ sf kit data csv convert -i ./path/to/input.csv -m ./path/to/mapping.json

Convert csv file using script and output to specified path:

$ sf kit data csv convert -i ./path/to/input.csv -f ./path/to/output.csv -c ./path/to/convert.js
`

_See code: src/commands/kit/data/csv/convert.ts_

sf kit graphql editor

Open the GraphQL Editor in a browser

`
USAGE
$ sf kit graphql editor -o [--json] [--flags-dir ] [-b chrome|firefox|edge] [-p ] [--api-version
]

FLAGS
-b, --browser= browser to use

-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
-p, --port= [default: 3000] local server port number
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Open the GraphQL Editor in a browser

It can interact with Salesforce GraphQL API using GraphiQL

EXAMPLES
$ sf kit graphql editor

$ sf kit graphql editor --port 8080
`

_See code: src/commands/kit/graphql/editor.ts_

sf kit layout assignments deploy

Deploy page layout assignments from JSON file.

`
USAGE
$ sf kit layout assignments deploy -f -o [--json] [--flags-dir ] [--api-version ]

FLAGS
-f, --file= (required) [default: config/layout-assignments.json] Input file path of page layout
assignment settings.
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

EXAMPLES
Deploy from the default file path to the default org:

$ sf kit layout assignments deploy

Deploy from the specified file to the default org:

$ sf kit layout assignments deploy -f config/layout-assignments.scratch.json

Deploy from the specified file to the specified org:

$ sf kit layout assignments deploy -o me@my.org -f config/layout-assignments.sandbox.json
`

_See code: src/commands/kit/layout/assignments/deploy.ts_

sf kit layout assignments retrieve

Retrieve page layout assignments and save to JSON file.

`
USAGE
$ sf kit layout assignments retrieve -f -o [--json] [--flags-dir ] [-p ...] [-s ...] [--merge]
[--api-version ]

FLAGS
-f, --file= (required) [default: config/layout-assignments.json] Output file path of page layout
assignment settings.
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
-p, --profile=... [default: all profiles] Profile names to retrieve
-s, --sobject=... [default: sobjects which have multiple layouts] SObject names to retrieve
--api-version= Override the api version used for api requests made by this command
--merge Merge retrieved configurations with existing file.

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

EXAMPLES
Retrieve page layout assignments from the default org and save to the default path:

$ sf kit layout assignments retrieve

Retrieve Admin profile's Account and Contact page layout assignments and save to the specified path:

$ sf kit layout assignments retrieve -p Admin -s Account -s Contact -f config/layout-assignments.scratch.json

Retrieve page layout assignments from the specified org and save to the specified path:

$ sf kit layout assignments retrieve -o me@my.org -f config/layout-assignments.sandbox.json
`

_See code: src/commands/kit/layout/assignments/retrieve.ts_

sf kit metadata dependencies

Analyze metadata dependencies

`
USAGE
$ sf kit metadata dependencies -o [--json] [--flags-dir ] [-b chrome|firefox|edge] [-p ] [--api-version
]

FLAGS
-b, --browser= browser to use

-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
-p, --port= [default: 3000] local server port number
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

EXAMPLES
$ sf kit metadata dependencies
`

_See code: src/commands/kit/metadata/dependencies.ts_

sf kit object fields describe

Describe sobject fields information.

`
USAGE
$ sf kit object fields describe -s -o [--json] [--flags-dir ] [-f ] [--api-version
]

FLAGS
-f, --file= Output csv file path
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
-s, --sobject= (required) SObject name to describe
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

EXAMPLES
Describe Account fields of the default org and save to csv file:

$ sf kit object fields describe -s Account -f path/to/account_fields.csv

Output CustomObject__c fields of the specified org as JSON format:

$ sf kit object fields describe -o me@my.org -s CustomObject__c --json
`

_See code: src/commands/kit/object/fields/describe.ts_

sf kit object fields setup

Upsert and delete sobject fields from a CSV file.

`
USAGE
$ sf kit object fields setup -s -f -o [--json] [--flags-dir ] [--delete] [--force]
[--api-version ]

FLAGS
-f, --file= (required) Input csv file path
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
-s, --sobject= (required) SObject name to setup
--api-version= Override the api version used for api requests made by this command
--delete Delete fields that are not in the csv file
--force Do not confirm when deleting

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

EXAMPLES
Upsert Account fields to the default org:

$ sf kit object fields setup -s Account -f path/to/account_fields.csv

Upsert and delete CustomObject__c fields to the specified org:

$ sf kit object fields setup -o me@my.org -s CustomObject__c -f path/to/custom_object_fields.csv --delete
`

_See code: src/commands/kit/object/fields/setup.ts_

sf kit script

Execute Node.js scripts in SfCommand context.

`
USAGE
$ sf kit script [--json] [--flags-dir ] [-f ] [-o ] [--api-version ]

FLAGS
-f, --file= The path of the Node.js script file to execute.
-o, --target-org= Username or alias of the target org.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Execute Node.js scripts in SfCommand context.

Available variables in Node.js scripts

- argv: Parsed command line arguments after the file option
- conn: jsforce Connection
- context: SfCommand

ALIASES
$ sf kit script

EXAMPLES
Execute from js file:

$ sf kit script -f ./path/to/script.js

Execute from js file with arguments:

$ sf kit script -f ./path/to/script.js -- --opt1 val1 --opt2 val2 arg1 arg2

Execute in REPL mode:

$ sf kit script -o target-org

query a account from org in REPL
> await conn.query('SELECT Id, Name FROM Account LIMIT 1')
`

sf kit script execute

Execute Node.js scripts in SfCommand context.

`
USAGE
$ sf kit script execute [--json] [--flags-dir ] [-f ] [-o ] [--api-version ]

FLAGS
-f, --file= The path of the Node.js script file to execute.
-o, --target-org= Username or alias of the target org.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Execute Node.js scripts in SfCommand context.

Available variables in Node.js scripts

- argv: Parsed command line arguments after the file option
- conn: jsforce Connection
- context: SfCommand

ALIASES
$ sf kit script

EXAMPLES
Execute from js file:

$ sf kit script execute -f ./path/to/script.js

Execute from js file with arguments:

$ sf kit script execute -f ./path/to/script.js -- --opt1 val1 --opt2 val2 arg1 arg2

Execute in REPL mode:

$ sf kit script execute -o target-org

query a account from org in REPL
> await conn.query('SELECT Id, Name FROM Account LIMIT 1')
``

_See code: src/commands/kit/script/execute.ts_