npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

heat-sfdx-cli

v0.4.9

Published

This is a Salesforce CLI plug-In, which uses features of the heat-sfdx series.

Downloads

98

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

takahitomiyamototakahitomiyamoto

Keywords

sfdx-plugin

Readme

heat-sfdx-cli

This is a Salesforce CLI plug-In, which uses features of the heat-sfdx series.

Version Appveyor CI Codecov Greenkeeper Known Vulnerabilities Downloads/week License

heat-sfdx series

| category | package | | :----------- | :--------------------------------------------------------------------------- | | Metadata API | heat-sfdx-metadata | | SOAP API | heat-sfdx-soap | | Tooling API | heat-sfdx-tooling | | Common | heat-sfdx-common |

How to install

sfdx plugins:install heat-sfdx-cli
# git clone https://github.com/takahitomiyamoto/heat-sfdx-cli.git
# cd heat-sfdx-cli/heat
# sfdx plugins:link
$ npm install -g heat-sfdx-cli
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
heat-sfdx-cli/0.4.9 darwin-x64 node-v18.16.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

sfdx heat:convert:json2csv [-e <string>] [-i <string>] [-o <string>] [--header] [--columns <string>] [-c <string>] [-k <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

convert a file

USAGE
  $ sfdx heat:convert:json2csv [-e <string>] [-i <string>] [-o <string>] [--header] [--columns <string>] [-c <string>] 
  [-k <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --charcode=charcode                                                           [default: utf8] character code

  -e, --environment=environment                                                     [default: config/environment.json]
                                                                                    environment file

  -i, --inputfile=inputfile                                                         input file

  -k, --keys=keys                                                                   [default:
                                                                                    Profile.applicationVisibilities]
                                                                                    JSON keys

  -o, --outputfile=outputfile                                                       output file

  --columns=columns                                                                 comma separated header columns (ex.
                                                                                    apexClass,enabled)

  --header                                                                          set this flag if the csv has a
                                                                                    header

  --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

  --verbose                                                                         emit additional command output to
                                                                                    stdout

EXAMPLE

  $ sfdx heat:convert:json2csv --header --columns apexClass,enabled -k Profile.classAccesses -i .heat-logs/input.json -o
   .heat-logs/output.csv

See code: src/commands/heat/convert/json2csv.ts

sfdx heat:convert:xml2json [-e <string>] [-i <string>] [-o <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

convert a file

USAGE
  $ sfdx heat:convert:xml2json [-e <string>] [-i <string>] [-o <string>] [--verbose] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -e, --environment=environment                                                     [default: config/environment.json]
                                                                                    environment file

  -i, --inputfile=inputfile                                                         input file

  -o, --outputfile=outputfile                                                       output file

  --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

  --verbose                                                                         emit additional command output to
                                                                                    stdout

EXAMPLE

  $ sfdx heat:convert:xml2json -i .heat-logs/input.xml -o .heat-logs/output.json

See code: src/commands/heat/convert/xml2json.ts

sfdx heat:manifest:build [-e <string>] [-x <string>] [-w <string>] [--beta] [--deleted] [--deprecated] [--deprecatededitable] [--installed] [--installededitable] [--released] [--unmanaged] [--standard] [--recommended] [--all] [--child] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

build manifest file with all metadata types in your org

USAGE
  $ sfdx heat:manifest:build [-e <string>] [-x <string>] [-w <string>] [--beta] [--deleted] [--deprecated] 
  [--deprecatededitable] [--installed] [--installededitable] [--released] [--unmanaged] [--standard] [--recommended] 
  [--all] [--child] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -e, --environment=environment                                                     [default: config/environment.json]
                                                                                    environment file

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

  -w, --wsdl=wsdl                                                                   [default: config/metadata.wsdl]
                                                                                    Metadata API WSDL file

  -x, --manifest=manifest                                                           [default: manifest/package.xml]
                                                                                    manifest file

  --all                                                                             set this flag if you would like to
                                                                                    contain any all components

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

  --beta                                                                            set this flag if you would like to
                                                                                    contain any beta components

  --child                                                                           set this flag if you would like to
                                                                                    contain any child sub-components

  --deleted                                                                         set this flag if you would like to
                                                                                    contain any deleted components

  --deprecated                                                                      set this flag if you would like to
                                                                                    contain any deprecated components

  --deprecatededitable                                                              set this flag if you would like to
                                                                                    contain any deprecatedEditable
                                                                                    components

  --installed                                                                       set this flag if you would like to
                                                                                    contain any installed components

  --installededitable                                                               set this flag if you would like to
                                                                                    contain any installedEditable
                                                                                    components

  --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

  --recommended                                                                     set this flag if you would like to
                                                                                    contain any standard, unmanaged, and
                                                                                    child sub-components

  --released                                                                        set this flag if you would like to
                                                                                    contain any released components

  --standard                                                                        set this flag if you would like to
                                                                                    contain any standard components

  --unmanaged                                                                       set this flag if you would like to
                                                                                    contain any unmanaged components

  --verbose                                                                         emit additional command output to
                                                                                    stdout

EXAMPLES

  [standard and unmanaged components] 
  $ sfdx heat:manifest:build --apiversion 52.0 -u [email protected] --standard --unmanaged

  [standard, unmanaged and unlocked components] 
  $ sfdx heat:manifest:build --apiversion 52.0 -u [email protected] --standard --unmanaged --installededitable

  [standard, unmanaged and child sub-components] 
  $ sfdx heat:manifest:build --apiversion 52.0 -u [email protected] --recommended

  [standard, unmanaged, unlocked, managed and child sub-components] 
  $ sfdx heat:manifest:build --apiversion 52.0 -u [email protected] --all

See code: src/commands/heat/manifest/build.ts

sfdx heat:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

print a greeting and your org IDs

USAGE
  $ sfdx heat:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -f, --force                                                                       example boolean flag
  -n, --name=name                                                                   name to print

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

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub 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 hello:org --targetusername [email protected] --targetdevhubusername [email protected]
    Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018!
    My hub org id is: 00Dxx000000001234
  
  $ sfdx hello:org --name myname --targetusername [email protected]
    Hello myname! This is org: MyOrg and I will be around until Tue Mar 20 2018!

See code: src/commands/heat/org.ts

sfdx heat:rest:get:execute [-e <string>] [-d <string>] [-f <string>] [-r <string>] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

REST API - execute GET

USAGE
  $ sfdx heat:rest:get:execute [-e <string>] [-d <string>] [-f <string>] [-r <string>] [-u <string>] [--apiversion 
  <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --outputdir=outputdir                                                         [default: .logs] output directory

  -e, --environment=environment                                                     [default: config/environment.json]
                                                                                    environment file

  -f, --outputfile=outputfile                                                       [default: result.json] output file

  -r, --url=url                                                                     [default: /tooling/sobjects] target
                                                                                    URL

  -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

  --verbose                                                                         emit additional command output to
                                                                                    stdout

EXAMPLE

  $ sfdx heat:rest:get:execute --apiversion 54.0 -u [email protected] -d .logs -f result.json -r 
  /tooling/sobjects/Profile/describe

See code: src/commands/heat/rest/get/execute.ts

sfdx heat:spec:apex:build [-e <string>] [-o <string>] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

build any specification documents of Apex classes or triggers in markdown format

USAGE
  $ sfdx heat:spec:apex:build [-e <string>] [-o <string>] [-u <string>] [--apiversion <string>] [--verbose] [--json] 
  [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -e, --environment=environment                                                     [default: config/environment.json]
                                                                                    environment file

  -o, --output=output                                                               [default: docs] output directory

  -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

  --verbose                                                                         emit additional command output to
                                                                                    stdout

EXAMPLE

  $ sfdx heat:spec:apex:build --apiversion 57.0 -u [email protected] -o docs

See code: src/commands/heat/spec/apex/build.ts

Debugging your plugin

We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the .vscode directory of this plugin is a launch.json config file, which allows you to attach a debugger to the node process when running your commands.

To debug the hello:org command:

  1. Start the inspector

If you linked your plugin to the sfdx cli, call your command with the dev-suspend switch:

$ sfdx hello:org -u [email protected] --dev-suspend

Alternatively, to call your command using the bin/run script, set the NODE_OPTIONS environment variable to --inspect-brk when starting the debugger:

$ NODE_OPTIONS=--inspect-brk bin/run hello:org -u [email protected]
  1. Set some breakpoints in your command code
  2. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
  3. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
  4. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
  5. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5). Congrats, you are debugging!