\n \n
\n \n
\n\n## What does it do?\n\nThe **ezissue cli** is an application with command line interface which it's main objective is to help you\nin the issue creation process in your projects.\n\nIt takes a file with a markdown table with your issues, formats them and send them to your repo's API.\nTherefore you will no longer spend hours creating issues manually.\n\n## Why should I use this?\nIf you find that the issue creation process is painfull and it breaks your *full-loko* mood while developing something, this is for you.\n\nBut if you want to spend hours creating issues on Github or Gitlab and find it fun (I sincerely doubt it), who am I to tell you what to do!\n\n## Usage and configuration\n\n### CLI interface\n\nThis program has a CLI that you can take advantage of. Running `ezissue --help`\nwill show you the usage and options for the CLI.\n\n```bash\n$ ezissue --help\n\n Usage: ezissue [OPTIONS] FILENAME [github|gitlab]\n\n Options:\n --subid TEXT\n --numerate BOOLEAN\n --prefix [US|TS||BUG]\n --help Show this message and exit.\n```\n\n### Markdown file and configuration\n\nThe EZIssue program takes a `.md` file as argument. That file must have a markdown table for it to parse to issues. That table is a common md table and can have the following headers: (Note that headers with `*` are mandatory, and with `**` are not yet implemented)\n\n| **Header name** | Description | Github support | Gitlab support |\n| ------------------- | :----------------------------------------------------------- | :-------------------------------: | :----------------------------------------------------------: |\n| Title* | Issue\u2019s title | Y | Y |\n| Description | Issue\u2019s body or description | Y | Y |\n| Tasks | Will be a list of checkboxes. Items must be separated with commas. | Y (goes with description) | Y (goes with description) |\n| Acceptance criteria | Will be a list of checkboxes. Items must be separated with commas. | Y (goes with description) | Y (goes with description) |\n| Assignee** | User that is assigned to the issue | Y (assignee\u2019s username) | N (see next row) |\n| Assignees** | List of users assigned to the issue | Y (array of assignee\u2019s usernames) | Y (is a array of user ids) |\n| Labels** | List of labels that are to be applied to the issue | Y (array of strings) | Y ( string, separated by commas) |\n| Confidential** | Toggles the confidentiality of the issue | N | Y (boolean value) |\n| Milestone** | Adds a milestone to the issue | Y (number of milestone) | Y (milestone id) |\n| Due** | Sets a due date for stressing out your team | N | Y (datetime string in format `YYYY-MM-DD`) |\n| Discussion** | Links the issue to a discussion thread | N | Y (id of the discussion that it solves. Fills the description automatically) |\n| Weight** | Sets the issue\u2019s weight. Best used in XP | N | Y (integer with the issue\u2019s weight, must be bigger than zero) |\n\n**Examples:**\n\nThe issue output format is the following:\n\n```markdown\n \n | title | description | acceptance criteria |\n | ----- | ----------- | ------------------- |\n | issue title | brief description | condition a;condition b;condition c |\n```\n\n\n\n```markdown\n \n