sfdc-generate-data-dictionary

generate data dictionary from a Salesforce Org

Getting Started

Works in Unix like system. Windows is not tested.

Installing

npm install -g sfdc-generate-data-dictionary

Usage

Command Line

$ sgd -h

  Usage: sgd [options]

  generate data dictionary from a Salesforce Org

  Options:

    -u, --username [username]                salesforce username
    -p, --password [password]                salesforce password
    -l, --loginUrl [loginUrl]                salesforce login URL [https://login.salesforce.com]
    -c, --customObjects [customObjects]      retrieve all custom objects [true]
    -s, --standardObjects [standardObjects]  standard sObjects to retrieve separated with commas
    -D, --debug [debug]                      generate debug log file [false]
    -d, --deleteFolders [deleteFolders]      delete/clean temp folders [true]
    -o, --output [dir]                       salesforce data dictionary directory path [.]

Module

  var sgd = require('sfdc-generate-data-dictionary');

  sgd({
      'username': '',
      'password': options.password,
      'loginUrl': options.loginUrl,
      'projectName': '',
      'allCustomObjects': true,
      'debug': false,
      'cleanFolders': true,
      'output':'.'
      }, console.log);

Built With

• commander - The complete solution for node.js command-line interfaces, inspired by Ruby's commander.
• bytes - Utility to parse a string bytes to bytes and vice-versa.
• excel4node - Node module to allow for easy Excel file creation.
• jsforce - Salesforce API Library for JavaScript applications (both on Node.js and web browser)

Versioning

SemVer is used for versioning.

Authors

• Gil Avignon - Initial work - gavignon

License

This project is licensed under the MIT License - see the <LICENSE.md> file for details