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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
|
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 includes a remote helper so native git commands (clone, fetch, push) work with nostr:// URLs\n - clone a nostr repository, or add as a remote, by using the url format nostr://npub123/identifier\n - remote branches beginning with `pr/` are open PRs from contributors; `ngit pr 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 set title and description via push options:\n git push -o 'title=My PR' -o 'description=line1\\n\\nline2' -u origin pr/branch\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.
- 'nostr.repo-relay-only true' to only publish nostr events to repo relays, skipping user and
default relays. Useful for repositories where you don't want to broadcast to your personal
relay set. Set via `git config nostr.repo-relay-only true` or `ngit init --repo-relay-only`.
- 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 {
/// publish a repository to nostr; signal you are its maintainer accepting
/// PRs and issues
Init(sub_commands::init::SubCommandArgs),
/// manage repository metadata and maintainership
#[command(
long_about = "manage repository metadata and maintainership\n\nrun without a subcommand to show repository info"
)]
Repo(RepoSubCommandArgs),
/// submit PR with advanced options
#[command(
long_about = "submit PR with advanced options\n\nfor a simpler flow, push a branch with the `pr/` prefix using native git:\n git push -o 'title=My PR' -o 'description=details here' -u origin pr/my-branch"
)]
Send(sub_commands::send::SubCommandArgs),
/// work with pull requests
#[command(
long_about = "work with pull requests\n\nPRs are created by pushing a branch with the `pr/` prefix:\n git push -u origin pr/my-branch\nor with advanced options via `ngit send`"
)]
Pr(PrSubCommandArgs),
/// work with issues
Issue(IssueSubCommandArgs),
/// update repo git servers to reflect nostr state (add, update or delete
/// remote refs)
Sync(sub_commands::sync::SubCommandArgs),
/// create account, 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,
}
#[derive(clap::Parser)]
pub struct RepoSubCommandArgs {
#[command(subcommand)]
pub repo_command: Option<RepoCommands>,
/// Use local cache only, skip network fetch
#[arg(long)]
pub offline: bool,
}
// ---------------------------------------------------------------------------
// PR subcommand group
// ---------------------------------------------------------------------------
#[derive(clap::Parser)]
pub struct PrSubCommandArgs {
#[command(subcommand)]
pub pr_command: PrCommands,
}
#[derive(Subcommand)]
pub enum PrCommands {
/// list PRs and view details
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)
#[arg(value_name = "ID|nevent")]
id: Option<String>,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// view a PR and its comments
View {
/// Proposal event-id (hex) or nevent (bech32)
#[arg(value_name = "ID|nevent")]
id: String,
/// Output as JSON
#[arg(long)]
json: bool,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// checkout a proposal branch by event-id or nevent
#[command(
long_about = "checkout a proposal branch by event-id or nevent\n\nuse `ngit pr list` to find proposal IDs"
)]
Checkout {
/// Proposal event-id (hex) or nevent (bech32)
#[arg(value_name = "ID|nevent")]
id: String,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// apply proposal patches to current branch
#[command(
long_about = "apply proposal patches to current branch\n\nuse `ngit pr list` to find proposal IDs"
)]
Apply {
/// Proposal event-id or nevent
#[arg(value_name = "ID|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,
},
/// submit PR with advanced options (alias for `ngit send`)
#[command(
long_about = "submit PR with advanced options\n\nfor a simpler flow, push a branch with the `pr/` prefix using native git:\n git push -o 'title=My PR' -o 'description=details here' -u origin pr/my-branch"
)]
Send(sub_commands::send::SubCommandArgs),
/// close a PR (author or maintainer only)
Close {
/// Proposal event-id (hex) or nevent (bech32)
#[arg(value_name = "ID|nevent")]
id: String,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// reopen a closed PR (author or maintainer only)
Reopen {
/// Proposal event-id (hex) or nevent (bech32)
#[arg(value_name = "ID|nevent")]
id: String,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// mark a draft PR as ready for review (author or maintainer only)
Ready {
/// Proposal event-id (hex) or nevent (bech32)
#[arg(value_name = "ID|nevent")]
id: String,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// add a comment to a PR
Comment {
/// Proposal event-id (hex) or nevent (bech32)
#[arg(value_name = "ID|nevent")]
id: String,
/// Comment body
#[arg(long)]
body: String,
/// Reply to a specific comment event-id (hex) or nevent (bech32);
/// defaults to top-level
#[arg(long, value_name = "ID|nevent")]
reply_to: Option<String>,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// merge a PR into the current branch (maintainer only)
#[command(
long_about = "merge a PR into the current branch (maintainer only)\n\nperforms a git merge of the PR branch; push afterwards to update the nostr state"
)]
Merge {
/// Proposal event-id (hex) or nevent (bech32)
#[arg(value_name = "ID|nevent")]
id: String,
/// Use squash merge
#[arg(long)]
squash: bool,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
}
// ---------------------------------------------------------------------------
// Issue subcommand group
// ---------------------------------------------------------------------------
#[derive(clap::Parser)]
pub struct IssueSubCommandArgs {
#[command(subcommand)]
pub issue_command: IssueCommands,
}
#[derive(Subcommand)]
pub enum IssueCommands {
/// list issues and their statuses
List {
/// Filter by status (comma-separated: open,draft,closed,applied)
#[arg(long, default_value = "open")]
status: String,
/// Filter by hashtag/label (comma-separated)
#[arg(long)]
hashtag: Option<String>,
/// Output as JSON
#[arg(long)]
json: bool,
/// Show details for a specific issue (event-id or nevent)
#[arg(value_name = "ID|nevent")]
id: Option<String>,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// view an issue and its comments
View {
/// Issue event-id (hex) or nevent (bech32)
#[arg(value_name = "ID|nevent")]
id: String,
/// Output as JSON
#[arg(long)]
json: bool,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// create a new issue
Create {
/// Issue title
#[arg(long)]
title: Option<String>,
/// Issue body / description
#[arg(long)]
body: Option<String>,
/// Hashtag labels (repeatable: --label bug --label help-wanted)
#[arg(long = "label", value_name = "LABEL")]
labels: Vec<String>,
},
/// close an issue (author or maintainer only)
Close {
/// Issue event-id (hex) or nevent (bech32)
#[arg(value_name = "ID|nevent")]
id: String,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// reopen a closed issue (author or maintainer only)
Reopen {
/// Issue event-id (hex) or nevent (bech32)
#[arg(value_name = "ID|nevent")]
id: String,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
/// add a comment to an issue
Comment {
/// Issue event-id (hex) or nevent (bech32)
#[arg(value_name = "ID|nevent")]
id: String,
/// Comment body
#[arg(long)]
body: String,
/// Reply to a specific comment event-id (hex) or nevent (bech32);
/// defaults to top-level
#[arg(long, value_name = "ID|nevent")]
reply_to: Option<String>,
/// Use local cache only, skip network fetch
#[arg(long)]
offline: bool,
},
}
#[derive(Subcommand)]
pub enum RepoCommands {
/// publish a repository to nostr (alias for `ngit init`)
Init(sub_commands::init::SubCommandArgs),
/// update repository metadata on nostr
#[command(
long_about = "update repository metadata on nostr\n\nlike `ngit init` but makes clear you are editing an existing repository"
)]
Edit(sub_commands::init::SubCommandArgs),
/// accept an invitation to co-maintain a repository
#[command(long_about = "accept an invitation to co-maintain a repository\n\n\
publishes your repository announcement to nostr, confirming your co-maintainership.\n\n\
This is required because your signed announcement is what ties your git state events\n\
to a specific repository coordinate chain, preventing scammers from attributing your\n\
commits to a fake repository. See `ngit repo info` for details on the maintainer model.")]
Accept(sub_commands::repo::accept::SubCommandArgs),
}
|