{"id":20768227,"url":"https://github.com/jsforce/jsforce-metadata-tools","last_synced_at":"2025-04-30T11:25:23.395Z","repository":{"id":36388374,"uuid":"40693258","full_name":"jsforce/jsforce-metadata-tools","owner":"jsforce","description":"Tools for deploying/retrieving package files using Metadata API via JSforce","archived":false,"fork":false,"pushed_at":"2019-02-22T16:32:36.000Z","size":49,"stargazers_count":38,"open_issues_count":8,"forks_count":26,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-14T04:40:24.192Z","etag":null,"topics":["jsforce","metadata-api","salesforce"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jsforce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-14T03:08:44.000Z","updated_at":"2023-07-26T10:52:08.000Z","dependencies_parsed_at":"2022-09-01T00:12:20.854Z","dependency_job_id":null,"html_url":"https://github.com/jsforce/jsforce-metadata-tools","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsforce%2Fjsforce-metadata-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsforce%2Fjsforce-metadata-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsforce%2Fjsforce-metadata-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsforce%2Fjsforce-metadata-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsforce","download_url":"https://codeload.github.com/jsforce/jsforce-metadata-tools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251689665,"owners_count":21627956,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jsforce","metadata-api","salesforce"],"created_at":"2024-11-17T11:36:37.400Z","updated_at":"2025-04-30T11:25:23.355Z","avatar_url":"https://github.com/jsforce.png","language":"JavaScript","readme":"# jsforce-metadata-tools [![Build Status](https://travis-ci.org/jsforce/jsforce-metadata-tools.svg)](https://travis-ci.org/jsforce/jsforce-metadata-tools)\n\nTools for deploying/retrieving package files using Salesforce Metadata API via [JSforce](https://jsforce.github.io/).\n\nProvides command line interface (CLI) to easily deploy/retrieve packages.\n\n\n## Install\n\n```\n$ npm install jsforce-metadata-tools -g\n```\n\n## Usage\n\n### Deploy\n\n#### Deploy package from local directory\n\n```\n$ jsforce-deploy -u username@example.org -p ${SF_PASSWORD} -D ./path/to/packageDir\n```\n\n#### Deploy package from ZIP archive file\n\n```\n$ jsforce-deploy -u username@example.org -p ${SF_PASSWORD} -Z ./path/to/package.zip\n```\n\n### Retrieve\n\n#### Retrieve package files and write them under the directory\n\n(Assuming that `./path/to/packageDir` directory has a `package.xml` file inside)\n```\n$ jsforce-retrieve -u username@example.org -p ${SF_PASSWORD} -D ./path/to/packageDir\n```\n\n#### Retrieve package files by specifying metadata types/members to retrieve\n\n```\n$ jsforce-retrieve -u username@example.org -p ${SF_PASSWORD} --memberTypes \"ApexClass:Class1,Class2;ApexPage:*\" -D ./path/to/distDir\n```\n\n#### Retrieve package files by specifying package names to retrieve\n\n```\n$ jsforce-retrieve -u username@example.org -p ${SF_PASSWORD} --packageNames \"Package1,Package2\" -D \"./path/to/distDir1,./path/to/distDir2\"\n```\n\n#### Retrieve package files by specifying package.xml file\n\n```\n$ jsforce-retrieve -u username@example.org -p ${SF_PASSWORD} -P ./path/to/package.xml -D ./path/to/distDir\n```\n\n#### Retrieve package and output as a ZIP archive file \n\n```\n$ jsforce-retrieve -u username@example.org -p ${SF_PASSWORD} --packageName Package1 -Z ./path/to/package.zip\n```\n\n\n### OAuth-based Authorization\n\nOnce the authorization is done in JSforce REPL, the same connection is also valid here (no password required)\n\n```\n$ jsforce\n\u003e .authorize\n\n...\n(OAuth authorization flow)\n...\n\nReceived authorization code. Please close the opened browser window.\nAuthorized. Fetching user info...\nLogged in as : username@example.org\n\u003e .exit\n\n$ jsforce-deploy -c username@example.org -D ./path/to/packageDir\n```\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsforce%2Fjsforce-metadata-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsforce%2Fjsforce-metadata-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsforce%2Fjsforce-metadata-tools/lists"}