git-ledger 0.1.0-alpha.1

Git-native record storage: each record is a ref with typed fields.
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

use std::path::PathBuf;

use clap::Parser;

#[derive(Parser)]
#[command(name = "git ledger", bin_name = "git ledger")]
#[command(
    author,
    version,
    about = "Git-native record storage.",
    long_about = None
)]
pub struct Cli {
    /// Path to the git repository. Defaults to the current directory.
    #[arg(short = 'C', long, global = true)]
    pub repo: Option<PathBuf>,

    #[command(subcommand)]
    pub command: Command,
}

#[derive(clap::Subcommand)]
pub enum Command {
    /// Create a new record.
    Create {
        /// The ref prefix (e.g. `refs/issues`).
        ref_prefix: String,

        /// Caller-provided ID. If omitted, uses sequential numbering.
        id: Option<String>,

        /// Use content-addressed ID (hash stdin).
        #[arg(long)]
        content_hash: bool,

        /// Set a field (repeatable). Format: key[=value]
        #[arg(long = "set", value_name = "KEY[=VALUE]")]
        fields: Vec<String>,

        /// Add a file to the record (repeatable). Format: [key=]path
        #[arg(long = "file", value_name = "[KEY=]PATH")]
        files: Vec<String>,

        /// Commit message.
        #[arg(short, long, default_value = "ledger: create")]
        message: String,
    },

    /// Read a record.
    Read {
        /// The full ref name (e.g. `refs/issues/1`).
        #[arg(name = "ref")]
        ref_name: String,
    },

    /// Update a record.
    Update {
        /// The full ref name.
        #[arg(name = "ref")]
        ref_name: String,

        /// Set a field (repeatable). Format: key[=value]
        #[arg(long = "set", value_name = "KEY[=VALUE]")]
        fields: Vec<String>,

        /// Add a file to the record (repeatable). Format: [key=]path
        #[arg(long = "file", value_name = "[KEY=]PATH")]
        files: Vec<String>,

        /// Delete a field (repeatable).
        #[arg(long = "delete", value_name = "KEY")]
        deletes: Vec<String>,

        /// Commit message.
        #[arg(short, long, default_value = "ledger: update")]
        message: String,
    },

    /// List all record IDs under a ref prefix.
    List {
        /// The ref prefix (e.g. `refs/issues`).
        ref_prefix: String,
    },

    /// Show the commit history for a record.
    Log {
        /// The full ref name (e.g. `refs/issues/1`).
        #[arg(name = "ref")]
        ref_name: String,
    },
}