settle 0.39.0

CLI tool for managing a digital Zettelkasten
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

use clap::{Arg, Command};

/// Generate the clap App by using a builer pattern
pub fn build() -> Command<'static>
{
    Command::new(env!("CARGO_PKG_NAME"))
    .version(env!("CARGO_PKG_VERSION"))
    .author("xylous <xylous.e@gmail.com>")
    .about("CLI tool to manage a digital Zettelkasten")

    .subcommand_required(true)
    .arg_required_else_help(true)

    .subcommand(Command::new("compl")
        .display_order(4)
        .arg(Arg::new("SHELL").required(true))
        .about("generate completion file for a given shell")
    )

    .subcommand(Command::new("sync")
        .display_order(1)
        .short_flag('S')
        .about("sync the database")
        .arg(Arg::new("PROJECT")
            .display_order(1)
            .conflicts_with_all(&["UPDATE", "RENAME", "GENERATE"])
            .short('p')
            .long("project")
            .takes_value(true)
            .help("helper option to --create and --move; specify working project")
        )
        .arg(Arg::new("CREATE")
            .display_order(2)
            .conflicts_with_all(&["UPDATE", "MOVE", "RENAME", "GENERATE"])
            .short('c')
            .long("create")
            .takes_value(true)
            .help("create a new Zettel")
        )
        .arg(Arg::new("UPDATE")
            .display_order(3)
            .conflicts_with_all(&["MOVE", "RENAME", "GENERATE"])
            .short('u')
            .long("--update")
            .takes_value(true)
            .help("update a note's metadata, given its path")
        )
        .arg(Arg::new("GENERATE")
            .display_order(4)
            .short('g')
            .long("--generate")
            .takes_value(false)
            .help("(re)generate the database")
        )
        .arg(Arg::new("MOVE")
            .display_order(5)
            .conflicts_with_all(&["RENAME", "GENERATE"])
            .short('m')
            .long("move")
            .takes_value(true)
            .requires("PROJECT")
            .help("move the matching Zettel to a project; requires --project")
        )
        .arg(Arg::new("RENAME")
            .display_order(6)
            .conflicts_with("GENERATE")
            .short('n')
            .long("rename")
            .min_values(2)
            .help("rename first argument to last argument, preserving project")
        )
    )

    .subcommand(Command::new("query")
        .display_order(2)
        .short_flag('Q')
        .about("query the database")
        .arg(Arg::new("TITLE")
            .display_order(1)
            .short('t')
            .long("title")
            .takes_value(true)
            .help("keep Zettel with a matching title")
        )
        .arg(Arg::new("PROJECT")
            .display_order(2)
            .short('p')
            .long("project")
            .takes_value(true)
            .help("keep Zettel that are in the matching projects")
        )
        .arg(Arg::new("TAG")
            .display_order(3)
            .short('g')
            .long("tag")
            .takes_value(true)
            .help("keep Zettel that have a matching tag name")
        )
        .arg(Arg::new("TEXT_REGEX")
            .display_order(4)
            .short('x')
            .long("text")
            .takes_value(true)
            .help("keep Zettel that contain some text")
        )
        .arg(Arg::new("LINKS")
            .display_order(5)
            .short('l')
            .long("links")
            .takes_value(true)
            .help("keep Zettel that have links to the matching Zettel")
        )
        .arg(Arg::new("BACKLINKS")
            .display_order(6)
            .short('b')
            .long("backlinks")
            .takes_value(true)
            .help("keep Zettel that have links from the matching Zettel")
        )
        .arg(Arg::new("LONERS")
            .display_order(7)
            .short('o')
            .long("loners")
            .takes_value(false)
            .help("keep Zettel that don't have any links to and fro")
        )
    )

    .subcommand(Command::new("ls")
        .display_order(3)
        .about("list things not related to notes")
        .arg(Arg::new("OBJECT")
            .required(true)
            .help("object to list (tags, projects, ghosts, path)"
        )
    ))
}