A powerful CLI tool for bootstrapping Minecraft plugins with modern development tooling.
- Interactive Setup: User-friendly CLI interface for creating new plugin projects
- Multiple Build Systems: Support for Maven and Gradle
- Smart Defaults: Intelligent project structure and naming conventions
- Modern Tooling: Built with TypeScript for reliability and maintainability
# Using npm
npm install -g foundry-cli
# Using yarn
yarn global add foundry-cli
To create a new plugin project, simply run:
foundry
Options:
-V, --version Output the version number
-y, --yes Skip confirmation prompts
-i, --inline Run in inline mode (no alternate screen)
--no-color Disable colors in output
-v, --verbose Show detailed error messages
-h, --help Display help message
# Start interactive setup
foundry
# Skip all confirmations
foundry --yes
# Run in inline mode
foundry --inline
# Inline mode with no confirmations
foundry -i -y
You can customize default behaviors using environment variables:
FOUNDRY_DEFAULT_AUTHOR
: Set default author nameFOUNDRY_DEFAULT_PACKAGE
: Set default package prefix
Contributions are welcome! Here's how you can help:
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
# Clone the repository
git clone https://github.com/abb3v/foundry.git
# Install dependencies
npm install
# Build the project
npm run build
# Link for local development
npm link
# Run in development mode
npm run dev
This project is licensed under the MIT License - see the LICENSE file for details.
- Built with Commander.js
- Interactive prompts powered by Inquirer.js
- Beautiful terminal interfaces with Chalk and Boxen