agpm 0.0.3

A command line interface to a amisgitpm project manager
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

//!This module deals with the arguments for amisgitpm.
//!
//!It uses the clap crate to deal with them. It takes sub-commands
//!facilitated by the enum `Command`.
//!This means that you interact with the CLI of the program is like this:
//!```bash
//!$ amisgitpm install https://github.com/helix-editor/helix
//!```
use clap::{Parser, Subcommand};
#[derive(Parser, Debug, Clone)]
#[clap(version, about)]
/// This struct is the one that takes the arguments from the command line.
pub struct Cli {
    #[clap(subcommand)]
    /// This argument holds an enum with the different subcommands
    pub com: Commands,
}

#[derive(Subcommand, Debug, Clone)]
/// This are the possible commands
pub enum Commands {
    /// Install a new git repo. It installs from URLs of two kinds.
    ///
    /// 1. git clone URL eg. `https://github.com/helix-editor/helix.git`
    ///
    /// 2. Local git repo URL. `///file:///home/user/Path/to/git/project`
    Install {
        #[clap(value_parser)]
        /// the git repo url
        /// To install a remote repo
        ///```bash
        ///
        ///amisgitpm install https://github.com/helix-editor/helix.git
        ///
        ///```
        /// To install a local repo
        ///
        ///```bash
        ///
        ///amisgitpm install file:///home/user/Path/to/git/project
        ///
        ///```
        url: String,
    },

    /// Update project(s)
    Update {
        #[clap(value_parser)]
        /// An optional list of project names to update independently.
        ///
        /// If not provided all projects are updated
        project: Vec<String>,
    },

    /// Update the suggestions, downloading all of them, and substituting those
    /// already present
    UpdateSuggestions,

    /// Uninstall a project
    Uninstall {
        #[clap(value_parser)]
        /// The project name to uninstall
        project: Vec<String>,
    },

    /// Get the last version of the project
    Restore {
        #[clap(value_parser)]
        /// The project to downgrade
        project: Vec<String>,
    },

    /// Uninstall then install a project
    Reinstall {
        #[clap(value_parser)]
        /// The project name to reinstall
        project: String,
    },

    /// Run the build instructions of a project
    Rebuild {
        #[clap(value_parser)]
        /// The project name to rebuild
        project: String,
    },

    /// Remove all srcs with no project associated
    ///
    /// It is `O(N^2)`, with `N` the number of installed projects
    /// It is parallelized, and therefore is panicky rather than reporting
    Clean,

    /// Edit the configuration of a project
    Edit {
        #[clap(value_parser)]
        /// The name of project to edit
        project: String,
    },

    /// Show the list of installed applications and their version
    List {
        #[clap(value_parser)]
        /// Packages from which to get detailed information
        project: Vec<String>,
    },

    /// Install amisgitpm with amisgitpm, check that everything is in place
    Bootstrap,
}