settle 0.38.1

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

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(
            Command::new("compl")
                .arg(Arg::new("SHELL").required(true))
                .about("generate completion file for a given shell"),
        )
        .subcommand(
            Command::new("new")
                .about("create a new Zettel and print its inbox status and title")
                .arg(
                    Arg::new("PROJECT")
                        .short('p')
                        .long("project")
                        .takes_value(true)
                        .help("create the new Zettel in a specified project"),
                )
                .arg(Arg::new("TITLE").required(true).help("title of Zettel")),
        )
        .subcommand(
            Command::new("mv")
                .about("move all matches into the given project")
                .arg(
                    Arg::new("PATTERN")
                        .required(true)
                        .help("a pattern/regex for the Zettel titles"),
                )
                .arg(
                    Arg::new("PROJECT")
                        .required(true)
                        .help("the project into which notes are put"),
                ),
        )
        .subcommand(
            Command::new("rename")
                .about("rename a Zettel")
                .arg(Arg::new("TITLE").required(true))
                .arg(Arg::new("NEW_TITLE").required(true)),
        )
        .subcommand(
            Command::new("update")
                .about("update the metadata of a Zettel")
                .arg(Arg::new("FILENAME").required(true).help("path to Zettel")),
        )
        .subcommand(
            Command::new("query")
                .about("return a list of Zettel whose title matches the text")
                .arg(
                    Arg::new("PATTERN")
                        .required(true)
                        .help("pattern for the title of Zettel"),
                ),
        )
        .subcommand(
            Command::new("find")
                .about("search Zettels by tag")
                .arg(Arg::new("TAG").required(true).help("tag of Zettel")),
        )
        .subcommand(
            Command::new("links")
                .about("list Zettel that <TITLE> links to")
                .arg(Arg::new("TITLE").required(true).help("title of Zettel")),
        )
        .subcommand(
            Command::new("backlinks")
                .about("list files linking to <TITLE>")
                .arg(Arg::new("TITLE").required(true).help("title of Zettel")),
        )
        .subcommand(
            Command::new("search")
                .about("list titles of Zettel that contain provided text")
                .arg(Arg::new("TEXT").required(true).help("text to be searched")),
        )
        .subcommand(Command::new("tags").about("list all tags registered in the database"))
        .subcommand(Command::new("projects").about("list all projects within the Zettelkasten"))
        .subcommand(Command::new("generate").about("(re)generate the database"))
        .subcommand(Command::new("ghosts").about("list Zettel mentioned, but not created"))
        .subcommand(Command::new("ls").about("list all existing Zettel"))
        .subcommand(Command::new("zk").about("return the path to the Zettelkasten"))
        .subcommand(Command::new("isolated").about(
            "list all Zettel (in the main zettelkasten) that aren't linked with other notes",
        ))
}