imag-contact 0.10.1

Part of the imag core distribution: imag-contact command
Documentation 
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209

//
// imag - the personal information management suite for the commandline
// Copyright (C) 2015-2020 Matthias Beyer <mail@beyermatthias.de> and contributors
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; version
// 2.1 of the License.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//

use clap::{Arg, App, SubCommand};

pub fn build_ui<'a>(app: App<'a, 'a>) -> App<'a, 'a> {
    app
       .arg(Arg::with_name("contact-ref-collection-name")
            .long("ref-collection")
            .takes_value(true)
            .required(false)
            .multiple(false)
            .default_value("contacts")
            .help("Name (Key) of the basepath setting in the configuration file to use"))

        .subcommand(SubCommand::with_name("list")
                   .about("List contacts")
                   .version("0.1")
                   .arg(Arg::with_name("filter")
                        .index(1)
                        .takes_value(true)
                        .required(false)
                        .multiple(true)
                        .value_name("FILTER")
                        .help("Filter by these properties (not implemented yet)"))
                   .arg(Arg::with_name("format")
                        .long("format")
                        .takes_value(true)
                        .required(false)
                        .multiple(false)
                        .value_name("FORMAT")
                        .help("Format to format the listing"))
                   .arg(Arg::with_name("json")
                        .long("json")
                        .takes_value(false)
                        .required(false)
                        .multiple(false)
                        .help("Print output as JSON"))
                   )

        .subcommand(SubCommand::with_name("import")
                   .about("Import contacts")
                   .version("0.1")
                   .arg(Arg::with_name("path")
                        .index(1)
                        .takes_value(true)
                        .required(true)
                        .multiple(false)
                        .value_name("PATH")
                        .help("Import from this file/directory"))

                   .arg(Arg::with_name("force-override")
                        .long("force")
                        .takes_value(false)
                        .required(false)
                        .multiple(false)
                        .help("Force to override existing entries"))
                   )

        .subcommand(SubCommand::with_name("show")
                   .about("Show contact")
                   .version("0.1")
                   .arg(Arg::with_name("hash")
                        .index(1)
                        .takes_value(true)
                        .required(true)
                        .multiple(false)
                        .value_name("HASH")
                        .help("Show the contact pointed to by this reference hash"))
                   .arg(Arg::with_name("format")
                        .long("format")
                        .takes_value(true)
                        .required(false)
                        .multiple(false)
                        .value_name("FORMAT")
                        .help("Format to format the contact when printing it"))
                   )

        .subcommand(SubCommand::with_name("edit")
                   .about("Edit contacts")
                   .version("0.1")
                   .arg(Arg::with_name("hash")
                        .index(1)
                        .takes_value(true)
                        .required(true)
                        .multiple(true)
                        .value_name("HASH")
                        .help("Edit the contact pointed to by this reference hash(es)"))
                   .arg(Arg::with_name("fail-on-parse-error")
                        .long("no-retry")
                        .takes_value(false)
                        .required(false)
                        .multiple(false)
                        .help("Fail immediately if vcard cannot be parsed after editing."))
                   )

        .subcommand(SubCommand::with_name("find")
                   .about("Find contact by grepping for a string (no regex yet)")
                   .version("0.1")
                   .arg(Arg::with_name("string")
                        .index(1)
                        .takes_value(true)
                        .required(true)
                        .multiple(true)
                        .value_name("grepstring")
                        .help("Find the contact by grepping for this string"))

                   .arg(Arg::with_name("find-show")
                        .long("show")
                        .short("s")
                        .takes_value(false)
                        .required(false)
                        .multiple(false)
                        .help("Show the result")
                        .conflicts_with("find-list")
                        )

                   .arg(Arg::with_name("find-list")
                        .long("list")
                        .short("l")
                        .takes_value(false)
                        .required(false)
                        .multiple(false)
                        .help("List the result")
                        .conflicts_with("find-show")
                        )

                   .arg(Arg::with_name("json")
                        .long("json")
                        .takes_value(false)
                        .required(false)
                        .multiple(false)
                        .help("Print output as JSON")
                        .conflicts_with("format")
                        .conflicts_with("find-show")
                        .conflicts_with("find-list"))

                   .arg(Arg::with_name("format")
                        .long("format")
                        .takes_value(true)
                        .required(false)
                        .multiple(false)
                        .value_name("FORMAT")
                        .help("Format to format the contact when printing it")
                        .conflicts_with("json")
                        .conflicts_with("find-show")
                        .conflicts_with("find-list"))

                   .arg(Arg::with_name("find-id")
                        .long("id")
                        .takes_value(false)
                        .required(false)
                        .multiple(false)
                        .help("Print the store ids of the found entries")
                        .conflicts_with("find-full-id")
                        .conflicts_with("json")
                        .conflicts_with("find-show")
                        .conflicts_with("find-list"))

                   .arg(Arg::with_name("find-full-id")
                        .long("full-id")
                        .takes_value(false)
                        .required(false)
                        .multiple(false)
                        .help("Print the path to the file in the store of the found entries")
                        .conflicts_with("find-id")
                        .conflicts_with("json")
                        .conflicts_with("find-show")
                        .conflicts_with("find-list"))


                   )

        .subcommand(SubCommand::with_name("create")
                   .about("Create a contact file (.vcf) and track it in imag.")
                   .version("0.1")
                   .arg(Arg::with_name("file-location")
                        .short("F")
                        .long("file")
                        .takes_value(true)
                        .required(false)
                        .multiple(false)
                        .value_name("PATH")
                        .help("Create this file. If a directory is passed, a file with a uuid as name will be created. vcf contents are dumped to stdout if this is not passed."))
                   .arg(Arg::with_name("dont-track")
                        .short("T")
                        .long("no-track")
                        .takes_value(false)
                        .required(false)
                        .multiple(false)
                        .help("Don't track the new vcf file if one is created."))
                   )
}