https://github.com/jsmithdev/sfmm
A CLI tool to manage Salesforce modules
https://github.com/jsmithdev/sfmm
package-manager salesforce salesforce-developers sf
Last synced: about 1 month ago
JSON representation
A CLI tool to manage Salesforce modules
- Host: GitHub
- URL: https://github.com/jsmithdev/sfmm
- Owner: jsmithdev
- Created: 2023-07-30T21:57:49.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T18:26:56.000Z (about 2 years ago)
- Last Synced: 2025-01-28T23:15:12.425Z (over 1 year ago)
- Topics: package-manager, salesforce, salesforce-developers, sf
- Language: JavaScript
- Homepage:
- Size: 58.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sfmm - Salesforce Module Manager
## Install
with Nodejs installed, install sfmm globally:
```bash
npm i -g sfmm
```
For one offs, using in CI/CD workflows, etc you can use npx:
```bash
npx sfmm [flags]
```
## Usage
You can use sfmm with a GitHub author and repo:
```bash
sfmm [flags]
```
You can also use a url:
```bash
sfmm [flags]
```
Flags:
```bash
-h, --help : Print out help message
-v, --version : Print out install version of sfmm
-d, --dev : Development mode (more logs)
```
## Actions
> All actions can be used with \ or \ \
| Action | Description | Usage | Flags |
| ------ | ----------- | ----- | ----- |
| add | Add modules from a remote sfdx project to your current sfdx project | `sfmm add [flags]` | `-s, --save : Save to config file`
`-i, --ignore : Append modules to .gitignore file`
`-a, --all : Include all files (typically not wanted)` |
| remove | Remove module from your current sfdx project and sfmm config file | `sfmm remove ` | (N/A) |
| open | Open the project in your default browser | `sfmm open ` | (N/A) |
| read | Print the project's README.md to the console | `sfmm read ` | (N/A) |
## Examples
```bash
# install component to current sfdx project's lwc directory
sfmm add jsmithdev extenda-modal
```
```bash
# via url, install modal component to current sfdx project's lwc directory
sfmm add https://github.com/jsmithdev/extenda-modal
```
```bash
# install modal component to current sfdx project's lwc directory and save to config file
sfmm add jsmithdev extenda-modal --save
```
```bash
# using short flags together
sfmm add jsmithdev extenda-modal -si
```
```bash
# remove modal component and from .sfmm config file
sfmm remove jsmithdev extenda-modal
```
```bash
# via url, remove modal component and from .sfmm config file
sfmm remove https://github.com/jsmithdev/extenda-modal
```
```bash
sfmm open
```
```bash
sfmm read
```
## Development
```bash
# clone sfmm
git clone https://github.com/jsmithdev/sfmm.git
# enter sfmm directory
cd sfmm
# install
npm i
# optionally, link to global npm modules
npm link
# test run linked module
sfmm add jsmithdev modal -si
# test run without linking
node index.js add jsmithdev modal -si
```