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
|
use anyhow::{Result, bail};
use clap::{Parser, Subcommand};
use ngit::login::SignerInfo;
use crate::sub_commands;
#[derive(Parser)]
#[command(
author,
version,
help_template = "{name} {version}\nnostr plugin for git\n - clone a nostr repository, or add as a remote, by using the url format nostr://pub123/identifier\n - remote branches beginning with `pr/` are open PRs from contributors; `ngit list` can be used to view all PRs\n - to open a PR, push a branch with the prefix `pr/` or use `ngit send` for advanced options\n- publish a repository to nostr with `ngit init`\n\n{usage}\n{all-args}"
)]
#[command(propagate_version = true)]
#[allow(clippy::struct_excessive_bools)]
pub struct Cli {
#[command(subcommand)]
pub command: Option<Commands>,
/// remote signer address
#[arg(long, global = true, hide = true)]
pub bunker_uri: Option<String>,
/// remote signer app secret key
#[arg(long, global = true, hide = true)]
pub bunker_app_key: Option<String>,
/// nsec or hex private key
#[arg(short, long, global = true)]
pub nsec: Option<String>,
/// password to decrypt nsec
#[arg(short, long, global = true, hide = true)]
pub password: Option<String>,
/// disable spinner animations
#[arg(long, action, hide = true)]
pub disable_cli_spinners: bool,
/// show customization options via git config
#[arg(short, long, global = true)]
pub customize: bool,
/// Use default values without prompting (non-interactive mode)
#[arg(short = 'd', long, global = true, conflicts_with = "interactive")]
pub defaults: bool,
/// Enable interactive prompts (default behavior)
#[arg(short = 'i', long, global = true)]
pub interactive: bool,
/// Force operations, bypass safety guards
#[arg(short = 'f', long, global = true)]
pub force: bool,
/// Enable verbose output
#[arg(short = 'v', long, global = true)]
pub verbose: bool,
}
pub const CUSTOMISE_TEMPLATE: &str = r"
==========================
Customize ngit
==========================
ngit settings are managed through the git config.
Currently the only settings not reachable through standard commands relate to default hardcoded relays:
- nostr.grasp-default-set - only used during `ngit init`
- nostr.relay-default-set - used for profile discovery and account bootstrapping
- nostr.relay-blaster-set - only used for repo announcement events
- nostr.relay-signer-fallback-set
These take a string of semi-colon separated websocket URLs without spaces. For example:
`git config --global nostr.relay-default-set 'wss://relay1.example.com;wss://relay2.example.com'`
Or just for this repository:
`git config nostr.relay-default-set 'wss://relay1.example.com;wss://relay2.example.com'`
Other useful settings:
- 'nostr.nostate true' to avoid publishing a state event when pushing to a nostr remote.
- Login settings configured during `ngit account login`:
- nostr.nsec - nsec or ncryptsec
- nostr.npub - used for ncryptsec and remote signer
- nostr.bunker-uri - used for remote signer
- nostr.bunker-app-key - used for remote signer
Other config settings are applied to the local repository but just for effiency reasons eg nostr.nip05 and nostr.protocol-push
==========================
";
pub fn extract_signer_cli_arguments(args: &Cli) -> Result<Option<SignerInfo>> {
if let Some(nsec) = &args.nsec {
Ok(Some(SignerInfo::Nsec {
nsec: nsec.to_string(),
password: None,
npub: None,
}))
} else if let Some(bunker_uri) = args.bunker_uri.clone() {
if let Some(bunker_app_key) = args.bunker_app_key.clone() {
Ok(Some(SignerInfo::Bunker {
bunker_uri,
bunker_app_key,
npub: None,
}))
} else {
bail!("cli argument bunker-app-key must be supplied when bunker-uri is")
}
} else if args.bunker_app_key.is_some() {
bail!("cli argument bunker-uri must be supplied when bunker-app-key is")
} else {
Ok(None)
}
}
#[derive(Subcommand)]
pub enum Commands {
/// signal you are this repo's maintainer accepting PRs and issues via nostr
Init(sub_commands::init::SubCommandArgs),
/// submit PR with advanced options
Send(sub_commands::send::SubCommandArgs),
/// list PRs; checkout, apply or download selected
List {
/// Filter by status (comma-separated: open,draft,closed,applied)
#[arg(long, default_value = "open,draft")]
status: String,
/// Output as JSON
#[arg(long)]
json: bool,
/// Show details for specific proposal (event-id or nevent)
id: Option<String>,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// checkout a proposal branch by event-id or nevent
Checkout {
/// Proposal event-id (hex) or nevent (bech32)
id: String,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// apply proposal patches to current branch
Apply {
/// Proposal event-id or nevent
id: String,
/// Output patches to stdout instead of applying
#[arg(long)]
stdout: bool,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// update repo git servers to reflect nostr state (add, update or delete
/// remote refs)
Sync(sub_commands::sync::SubCommandArgs),
/// login, logout or export keys
Account(AccountSubCommandArgs),
}
#[derive(Subcommand)]
pub enum AccountCommands {
/// login with nsec or nostr connect
Login(sub_commands::login::SubCommandArgs),
/// remove nostr account details stored in git config
Logout,
/// export nostr keys to login to other nostr clients
ExportKeys,
/// create a new nostr account
Create(sub_commands::create::SubCommandArgs),
}
#[derive(clap::Parser)]
pub struct AccountSubCommandArgs {
#[command(subcommand)]
pub account_command: AccountCommands,
}
|