rudric 0.1.7

CLI tool for managing secrets in a secure way
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

use clap::{Args, Parser, Subcommand};

use crate::types::shell_type::ShellType;

/// Store secrets in an encrypted state on disk
#[derive(Parser)]
#[command(author, version, about, long_about = None)]
pub struct Cli {
    /// Specify a subcommand
    #[command(subcommand)]
    pub command: Command,

    /// Specify an alternate config directory
    #[arg(short, long)]
    pub config_dir: Option<String>,
}

/// The subcommand to execute
#[derive(Subcommand)]
pub enum Command {
    /// Set a master password and initialize the database
    Init,

    /// Create a new secret. Appending `-` at the end of the command will read the secret
    /// content from stdin or a pipe. (Note: A session must be active)
    Create {
        /// The name of the secret (must be unique)
        name: String,

        /// Set the secret description
        #[arg(short, long)]
        description: Option<String>,

        /// Read from stdin instead of opening the user's editor
        #[arg(hide = true)]
        stdin: Option<String>,

        /// Read the secret value from a file
        #[arg(short, long)]
        file: Option<String>,
    },

    /// Fetch a secret value
    Get {
        /// The name of the secret
        name: String,

        /// Output the secret in json format
        #[arg(long)]
        json: bool,
    },

    /// Edit an existing secret. Will open the secret value in $EDITOR or $VISUAL
    Edit {
        /// The name of the secret
        name: String,

        /// Edit the secret description
        #[arg(short = 'd', long)]
        description: bool,
    },

    /// Delete a secret. Asks for confirmation
    Delete {
        /// The name of the secret
        name: String,
    },

    /// Rename a secret
    Rename {
        /// The current name of the secret
        name: String,

        /// The new name of the secret. If blank, the user will be prompted for a new name
        new_name: Option<String>,
    },

    /// List all secrets
    List,

    /// Create a new session token. Setting this token as `RUDRIC_SESSION` in the environment will
    /// prevent the user from being prompted for the password each time the program is invoked.
    Session(SessionArgs),

    /// Read from the .renv file (or an alternate file) and set the specified variables in the environment.
    /// This command generates the shell code necessary to set the requested
    /// environment variables. The output of this command must be sourced with something like
    /// `rudric env | source`
    Env {
        /// The shell format to use. Defaults to bash but an alternate can be specified in the config
        /// file.
        shell: Option<ShellType>,

        /// Use an alternate environment file
        #[arg(short, long)]
        file: Option<String>,
    },

    /// Generate shell completions
    GenerateCompletions {
        /// The shell to generate completions for
        shell: ShellType,
    },

    /// Change the master password for the vault
    ChangePassword,
}

#[derive(Args)]
pub struct SessionArgs {
    #[command(subcommand)]
    pub command: Option<SessionCmd>,
}

#[derive(Subcommand)]
pub enum SessionCmd {
    /// Create a new session token
    New,
    /// Invalidates the current session token
    End,
}