1.0.3 • Published 5 months ago
aa-sheesh v1.0.3
npx aa-sheesh
aa-sheesh is a CLI tool that displays a stylish, interactive business card in your terminal. It showcases your contact details and provides an option for users to open their default email client to contact you directly.
Features
- Stylish Terminal Output: Uses chalk and boxen to display your business card in a visually appealing box.
- Interactive Prompt: Incorporates inquirer to allow users to choose whether to email you or exit.
- Seamless Email Integration: Leverages open to launch the default email client with a pre-addressed mailto link.
- Cross-Platform Compatibility: Works on Windows, macOS, and Linux.
Installation & Usage
Running via npx (No Global Installation Required)
You can run the CLI tool directly using npx:
npx aa-sheesh
Contributing
Contributions are welcome! Follow these steps to help improve the project:
Fork the Repository: Click the "Fork" button on GitHub to create your own of the repository.
Clone Your Fork:
git clone https://github.com/yourusername/aa-sheesh.git
cd aa-sheesh
- Create a New Branch:
git checkout -b feature/your-feature-name
Implement Your Changes: Make your changes, add new features, or fix bugs. Test your changes thoroughly.
Commit Your Changes:
Use clear, descriptive commit messages:
git commit -m "Add [feature/bugfix]: brief description of your changes"
- Push to Your Fork:
git push origin feature/your-feature-name
- Submit a Pull Request: Open a pull request on the original repository, describing your changes in detail. Your pull request will be reviewed and merged if approved.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Contact
- Developer: Aashish Singh
- Email: aashishs4912345@gmail.com
- GitHub: Aa-sheesh