auto-publish-github
v1.1.5
Published
A CLI tool to automate creating GitHub repositories and pushing local files to remote repositories. Simplifies repository management with automated GitHub workflows, custom .gitignore generation, and fast publishing.
Downloads
43
Maintainers
Readme
Auto Publish GitHub CLI
The Auto Publish GitHub CLI (auto-publish-github
) is a feature-packed command-line tool designed for developers to automate the process of creating GitHub repositories and publishing code. By streamlining repository management and automating tedious tasks, this tool helps developers save time and focus on coding.
🌟 Why Use Auto Publish GitHub CLI?
- Save Time: Combines repository creation,
.gitignore
setup, and project publishing in one command. - Simplify Workflows: Perfect for developers managing multiple projects or setting up repositories regularly.
- Beginner-Friendly: Intuitive interface for quick onboarding.
- Customizable: Select specific files or folders to exclude using a custom
.gitignore
file.
🚀 Key Features
- Automated Repository Creation: Initialize new GitHub repositories directly from your terminal.
- Custom
.gitignore
File: Effortlessly generate and edit.gitignore
files during setup. - Streamlined Code Publishing: Push your local projects to GitHub with a single command.
🛠 Installation Guide
Install auto-publish-github
globally using npm:
npm install -g auto-publish-github
After instalation, run directly with npx
:
npx auto-publish-github init
🔧 How to Use
Step 1: Initialize the Tool
Kick off the automation process by running:
npx auto-publish-github init
Step 2: Authenticate with GitHub
Securely provide your GitHub credentials to enable repository creation.
Step 3: Configure .gitignore
Select files or directories to exclude from your repository during setup.
Step 4: Publish Your Project
After setup, your project will be committed and pushed to your new GitHub repository.
🖥 Command Example
npx auto-publish-github init
This command will:
- Create a new GitHub repository.
- Generate and configure a
.gitignore
file. - Push your project to the repository, ready for collaboration.
🌐 SEO-Optimized Benefits
- Automated GitHub Workflow: For developers seeking faster, simpler ways to manage repositories.
- Command-Line Efficiency: Ideal for those who prefer terminal-based tools.
- GitHub Automation: Tailored for developers, freelancers, and DevOps teams.
📧 Support & Feedback
For issues, suggestions, or questions, reach out to us:
Email: [email protected]
📄 License
This project is distributed under the MIT License.
🌟 Contributions
Contributions are welcome! If you're interested in improving this tool or adding new features, contact us via [email protected].
🔗 Relevant Links
- NPM Package: auto-publish-github
- GitHub Repository: GitHub
🙌 Inspiration & Thanks
This project was inspired by the course Automate GitHub: Build a CLI App with Node.js by Lea Verou . Their insights and teaching provided a strong foundation for building this tool.
Thank you, Lea Verou , for your contributions to the developer community! 🎉
Simplify your development workflow with Auto Publish GitHub CLI. 🚀