Add the view command to the readme

This commit is contained in:
Daan Boerlage 2025-01-21 21:35:17 +01:00
parent b229ce9c5c
commit 21203eed43
Signed by: daan
GPG key ID: FCE070E1E4956606
2 changed files with 21 additions and 0 deletions

View file

@ -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] <ISSUE>
Arguments:
<ISSUE> 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:

View file

@ -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)]