From 21203eed431b822205985cdfd09a4140bab19096 Mon Sep 17 00:00:00 2001 From: Daan Boerlage Date: Tue, 21 Jan 2025 21:35:17 +0100 Subject: [PATCH] Add the view command to the readme --- readme.md | 20 ++++++++++++++++++++ src/cli.rs | 1 + 2 files changed, 21 insertions(+) diff --git a/readme.md b/readme.md index e957457..5f3d44f 100644 --- a/readme.md +++ b/readme.md @@ -27,6 +27,7 @@ Commands: create Create an issue list Find issues currently assigned to you search Search for issues + view View an issue init Set up the configuration help Print this message or the help of the given subcommand(s) @@ -104,6 +105,25 @@ Use [JQL](https://support.atlassian.com/jira-software-cloud/docs/use-advanced-se jirac search 'project = KEY AND status = "In Progress" ORDER BY created DESC' ``` +### View an issue + +``` +View an issue + +Usage: jirac view [OPTIONS] + +Arguments: + An issue key, for example, KEY-123 + +Options: + --json Print JSON rather than pretty print + -h, --help Print help +``` + +```sh +./target/release/jirac view KEY-123 +``` + ## Configuration Get the following information: diff --git a/src/cli.rs b/src/cli.rs index 28817fb..b60e63d 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -40,6 +40,7 @@ pub enum Commands { #[arg(value_name = "JQL")] jql: String, }, + /// View an issue View { /// Print JSON rather than pretty print #[arg(long)]