Skip to main content

Contribute to LazyCLI

Help us build the ultimate CLI automation tool. Contribute custom commands, improvements, or create your own minimal versions.

View on GitHub

How to Contribute

Follow these steps to add your custom commands or improvements to LazyCLI.

1

Fork the Repository

Start by forking the main LazyCLI repository to your GitHub account.

Fork on GitHub
2

Clone & Create Branch

Clone your fork locally and create a new feature branch for your contribution.

git clone https://github.com/your-username/lazycli.git
cd lazycli
git checkout -b feature/your-command
3

Add Your Script

Create a new folder under /public with your custom script.

Directory Structure:

/public
└── myscript/
└── lazy.sh

During development, test from your own repository:

curl -s https://raw.githubusercontent.com/your-username/lazycli/your-branch/public/scripts/lazy.sh | bash

After merging, it will be available at:

curl -s https://lazycli.xyz/scripts/myscript/lazy.sh | bash
4

Test Your Command

Test your script from your own repository before submitting to ensure it works as expected.

# Test from your GitHub fork
curl -s https://raw.githubusercontent.com/your-username/lazycli/your-branch/public/scripts/lazy.sh | bash

# Or test locally
bash /path/to/your/lazy.sh
5

Submit Pull Request

Push your changes and create a pull request with a clear description.

git add .
git commit -m 'Add: new command for [feature]'
git push origin feature/your-command
6

Install Your Custom Version

Once your version is available, users can install your custom LazyCLI version directly.

curl -s https://lazycli.xyz/install.sh | bash

Custom Version Installation:

Users can install your custom LazyCLI version using:

Standard Installation:
curl -s https://lazycli.xyz/install.sh | bash
Custom Version Installation:
curl -s https://lazycli.xyz/install.sh | bash -s version_name

Replace version_name with your custom version identifier (e.g., v1.0.2, custom-branch, etc.)

Create Custom Versions

Build your own minimal CLI tools with only the features you need.

Minimal Custom Builds

Create lightweight versions with only the commands you need (pm2, aws, github, etc.)

Copy Core Components

Fork the core repository and remove unnecessary commands to create your custom version

Team-Specific Scripts

Build organization-specific CLI tools with your team's preferred workflows

Contribution Guidelines

Please follow these guidelines to ensure your contribution is accepted.

Code Standards

  • Write clear, documented bash scripts
  • Include error handling and validation
  • Test on multiple environments
  • Follow existing naming conventions

Pull Request Tips

  • Provide clear description of changes
  • Include usage examples
  • Update documentation if needed
  • Be responsive to feedback