create-inforge-project

Scaffold new Salesforce projects from the Inforge boilerplate with automated setup.

A CLI tool that clones the Inforge Salesforce project template, customizes it for your new project, and runs automated setup including dependency installation and git hook configuration.

Usage

npx create-inforge-project <project-name>

Example:

npx create-inforge-project my-salesforce-app

This will:

1. ✓ Validate project name
2. ✓ Clone the Inforge Salesforce boilerplate
3. ✓ Reinitialize as a fresh git repository
4. ✓ Update package.json with your project name
5. ✓ Install dependencies automatically
6. ✓ Set up Husky git hooks
7. ✓ Display next steps

Authentication

When you run the tool, you'll be prompted to choose your authentication method:

SSH (recommended for team members):

• Automatically detects your SSH host configurations from ~/.ssh/config
• Select from detected hosts or enter a custom repository URL
• Requires SSH keys configured for GitHub access

HTTPS (public access):

• Simple, no SSH setup required
• Uses the default repository URL
• May prompt for credentials if repository is private

SSH Configuration Example

If you have a custom SSH config in ~/.ssh/config:

Host github-work
    HostName github.com
    User git
    IdentityFile ~/.ssh/id_rsa_work

The tool will detect "github-work" and allow you to select it.

Requirements

• Node.js 18.0.0 or higher
• npm (comes with Node.js)
• Git for cloning and version control
• SSH or HTTPS access to the Inforge Salesforce repository
• gitleaks (optional but recommended) - for git hook secret scanning

Installing gitleaks

macOS:

brew install gitleaks

Windows:

choco install gitleaks

Linux: See gitleaks installation guide

Project Name Rules

Project names must follow npm package naming conventions:

• Lowercase only
• Letters, numbers, hyphens (-), and underscores (_)
• No spaces or special characters

Valid: my-salesforce-app, salesforce_project, myapp123 Invalid: My Project, my@app, MYAPP

What Gets Created

After running the command, you'll have a new directory with:

• Complete Salesforce DX project structure
• Lightning Web Components setup
• AI-assisted development standards (.claude/ directory)
• Husky git hooks for code quality
• All dependencies installed
• Fresh git repository initialized

Next Steps

After project creation:

1. Navigate to your project:

   cd <project-name>

2. Authenticate with Salesforce:

   sf org login web

3. Start developing!

Check out the project's README.md for detailed documentation on:

• AI-assisted development workflows
• Code quality standards
• Commit conventions
• Salesforce DX commands

Error Handling

If something goes wrong during setup, the tool will:

• Display a clear error message
• Automatically clean up any partially created files
• Provide suggestions for fixing the issue

Troubleshooting

"Failed to clone repository"

• Ensure you have SSH access configured for GitHub
• Test with: ssh -T [email protected]
• See: GitHub SSH setup guide

"Directory already exists"

• Choose a different project name
• Or remove the existing directory first

"git command not found"

• Install Git: https://git-scm.com/downloads

License

MIT

Built with ❤️ by Inforge