Add documentation to the cli args
This commit is contained in:
parent
63b1f33a0a
commit
43e32a303d
2 changed files with 26 additions and 11 deletions
10
src/cli.rs
10
src/cli.rs
|
@ -10,25 +10,35 @@ pub struct Cli {
|
|||
|
||||
#[derive(Subcommand)]
|
||||
pub enum Commands {
|
||||
/// Create a ticket
|
||||
Create {
|
||||
/// The project key in which to create the ticket
|
||||
#[arg(long)]
|
||||
project: Option<String>,
|
||||
|
||||
/// Open the new ticket in a browser
|
||||
#[arg(long)]
|
||||
open: bool,
|
||||
|
||||
/// A markdown file
|
||||
#[arg(value_name = "MARKDOWN_FILE")]
|
||||
markdown_file: Option<PathBuf>,
|
||||
},
|
||||
/// Find tickets currently assigned to you
|
||||
List {
|
||||
/// Print json rather than pretty print
|
||||
#[arg(long)]
|
||||
json: bool,
|
||||
},
|
||||
/// Setup the configuration
|
||||
Init {
|
||||
/// Jira instance URL
|
||||
#[arg(long)]
|
||||
url: String,
|
||||
/// User email
|
||||
#[arg(long)]
|
||||
email: String,
|
||||
/// User Token
|
||||
#[arg(long)]
|
||||
token: String,
|
||||
},
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue