added documentation
This commit is contained in:
@@ -1,13 +1,14 @@
|
||||
use clap::Parser;
|
||||
use std::path::PathBuf;
|
||||
|
||||
/// mould: A TUI tool to generate and edit configuration files (.env, json, yaml, toml)
|
||||
#[derive(Parser, Debug)]
|
||||
#[command(author, version, about = "mould: A TUI tool to generate and edit configuration files (.env, json, yaml, toml)")]
|
||||
#[command(author, version, about)]
|
||||
pub struct Cli {
|
||||
/// The input template file (e.g., .env.example, config.json.template, docker-compose.yml)
|
||||
pub input: PathBuf,
|
||||
|
||||
/// Optional output file. If not provided, it will be inferred (e.g., .env.example -> .env, docker-compose.yml -> docker-compose.override.yml)
|
||||
/// Optional output file. If not provided, it will be inferred.
|
||||
#[arg(short, long)]
|
||||
pub output: Option<PathBuf>,
|
||||
|
||||
@@ -16,6 +17,7 @@ pub struct Cli {
|
||||
pub format: Option<String>,
|
||||
}
|
||||
|
||||
/// Parses and returns the command-line arguments.
|
||||
pub fn parse() -> Cli {
|
||||
Cli::parse()
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user