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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
use clap::{ArgAction, Parser, Subcommand, ValueEnum};
use clap_complete::Shell;
use std::path::PathBuf;
#[derive(Parser)]
#[command(name = "dsc")]
#[command(about = "Discourse CLI", long_about = None)]
pub struct Cli {
/// Path to the config file. If omitted, dsc searches standard locations.
#[arg(long, short = 'c')]
pub config: Option<PathBuf>,
/// Describe destructive actions without sending them. Read-only commands
/// ignore the flag.
#[arg(long, short = 'n', global = true)]
pub dry_run: bool,
#[command(subcommand)]
pub command: Commands,
}
#[derive(Subcommand)]
pub enum Commands {
/// List configured Discourses.
#[command(visible_alias = "ls")]
List {
/// Output format for the listing.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: OutputFormat,
/// Filter by tags (comma/semicolon separated, match-any).
#[arg(long, value_name = "tag1,tag2")]
tags: Option<String>,
/// Open each listed Discourse base URL in a browser tab/window.
#[arg(long, short = 'o')]
open: bool,
/// Include empty results and verbose listing details where supported.
#[arg(long, short = 'v')]
verbose: bool,
#[command(subcommand)]
command: Option<ListCommand>,
},
/// Add one or more Discourses to the config.
#[command(visible_alias = "a")]
Add {
/// Comma-separated discourse names to add.
names: String,
/// Prompt for additional optional fields while adding.
#[arg(long, short = 'i')]
interactive: bool,
},
/// Import Discourses from a file or stdin.
#[command(visible_alias = "imp")]
Import {
/// Path to import input (text/CSV). Reads stdin when omitted.
path: Option<PathBuf>,
},
/// Run remote OS + Discourse update workflow for one or all Discourses.
#[command(visible_alias = "up")]
Update {
/// Discourse name, or 'all' to update every configured Discourse.
name: String,
/// Parallel update mode for `dsc update all`.
#[arg(long, short = 'p')]
parallel: bool,
/// Maximum workers when parallel mode is enabled (default: 3).
#[arg(long, short = 'm')]
max: Option<usize>,
/// Disable changelog posting (posting prompt is on by default).
#[arg(long = "no-changelog", action = ArgAction::SetFalse, default_value_t = true)]
post_changelog: bool,
/// Auto-confirm changelog posting prompt (non-interactive mode).
#[arg(long, short = 'y')]
yes: bool,
},
/// Manage custom emoji.
#[command(visible_alias = "em")]
Emoji {
#[command(subcommand)]
command: EmojiCommand,
},
/// Pull/push/sync topics as local Markdown.
#[command(visible_alias = "t")]
Topic {
#[command(subcommand)]
command: TopicCommand,
},
/// List/copy/pull/push categories.
#[command(visible_alias = "cat")]
Category {
#[command(subcommand)]
command: CategoryCommand,
},
/// List/inspect/copy groups.
#[command(visible_alias = "grp")]
Group {
#[command(subcommand)]
command: GroupCommand,
},
/// Operations that act from a user's perspective.
#[command(visible_alias = "usr")]
User {
#[command(subcommand)]
command: UserCommand,
},
/// Create/list/restore backups.
#[command(visible_alias = "bk")]
Backup {
#[command(subcommand)]
command: BackupCommand,
},
/// List/pull/push color palettes.
#[command(visible_alias = "pal")]
Palette {
#[command(subcommand)]
command: PaletteCommand,
},
/// List/install/remove plugins.
#[command(visible_alias = "plg")]
Plugin {
#[command(subcommand)]
command: PluginCommand,
},
/// List/install/remove/pull/push/duplicate themes.
#[command(visible_alias = "th")]
Theme {
#[command(subcommand)]
command: ThemeCommand,
},
/// Update site settings.
#[command(visible_alias = "set")]
Setting {
#[command(subcommand)]
command: SettingCommand,
},
/// List tags and apply/remove them on topics.
#[command(visible_alias = "tg")]
Tag {
#[command(subcommand)]
command: TagCommand,
},
/// Post-level operations: edit / delete / move.
#[command(visible_alias = "po")]
Post {
#[command(subcommand)]
command: PostCommand,
},
/// Open a Discourse in the default browser.
#[command(visible_alias = "o")]
Open {
/// Discourse name.
discourse: String,
},
/// Search topics on a Discourse.
#[command(visible_alias = "s")]
Search {
/// Discourse name.
discourse: String,
/// Search query (passed through verbatim, including any
/// Discourse filter syntax like `category:foo` or `@user`).
query: String,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
},
/// Upload a file. Prints the resulting upload:// short URL by default.
#[command(visible_alias = "u")]
Upload {
/// Discourse name.
discourse: String,
/// Path to the file to upload.
file: PathBuf,
/// Discourse upload context. Default `composer` is correct for
/// embedding in posts; other values include `avatar`,
/// `profile_background`, `card_background`, `custom_emoji`.
#[arg(long, short = 't', default_value = "composer")]
upload_type: String,
/// Output format. Text mode prints just the short URL.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
},
/// Inspect and validate configuration.
#[command(visible_alias = "cfg")]
Config {
#[command(subcommand)]
command: ConfigCommand,
},
/// Generate shell completion scripts.
#[command(visible_alias = "comp")]
Completions {
/// Target shell.
#[arg(value_enum)]
shell: CompletionShell,
/// Output directory. Prints to stdout when omitted.
#[arg(long, short = 'd')]
dir: Option<PathBuf>,
},
/// Print the dsc version.
#[command(visible_alias = "ver")]
Version,
}
#[derive(Subcommand)]
pub enum ConfigCommand {
/// Probe each configured Discourse: API auth and (optionally) SSH reachability.
#[command(visible_alias = "ck")]
Check {
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
/// Skip the SSH reachability probe.
#[arg(long)]
skip_ssh: bool,
},
}
#[derive(Subcommand)]
pub enum ListCommand {
/// Sort discourse entries by name and rewrite config in-place.
/// Also inserts placeholder values for unset template keys.
#[command(visible_alias = "ty")]
Tidy,
}
#[derive(Subcommand)]
pub enum EmojiCommand {
/// Upload one emoji file, or bulk-upload from a directory.
#[command(visible_alias = "a")]
Add {
/// Discourse name.
discourse: String,
/// Local file or directory path.
emoji_path: PathBuf,
/// Optional emoji name (file uploads only).
emoji_name: Option<String>,
},
/// List custom emojis on a Discourse.
#[command(visible_alias = "ls")]
List {
/// Discourse name.
discourse: String,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
/// Include additional fields where supported.
#[arg(long, short = 'v')]
verbose: bool,
/// Render inline images when terminal protocol support is available.
#[arg(long, short = 'i')]
inline: bool,
},
}
#[derive(Subcommand)]
pub enum TopicCommand {
/// Pull a topic to a local Markdown file.
#[command(visible_alias = "pl")]
Pull {
/// Discourse name.
discourse: String,
/// Topic ID.
topic_id: u64,
/// Destination file or directory (auto-derived when omitted).
local_path: Option<PathBuf>,
},
/// Push a local Markdown file to a topic.
#[command(visible_alias = "ps")]
Push {
/// Discourse name.
discourse: String,
/// Topic ID.
topic_id: u64,
/// Local Markdown file path.
local_path: PathBuf,
},
/// Sync a topic and local Markdown file using newest timestamp.
#[command(visible_alias = "sy")]
Sync {
/// Discourse name.
discourse: String,
/// Topic ID.
topic_id: u64,
/// Local Markdown file path.
local_path: PathBuf,
/// Skip sync confirmation prompt.
#[arg(long, short = 'y')]
yes: bool,
},
/// Reply to a topic with content from a file or stdin.
#[command(visible_alias = "r")]
Reply {
/// Discourse name.
discourse: String,
/// Topic ID.
topic_id: u64,
/// Input file path. Reads stdin when omitted or `-`.
local_path: Option<PathBuf>,
},
/// Create a new topic in a category, body from a file or stdin.
#[command(visible_alias = "n")]
New {
/// Discourse name.
discourse: String,
/// Target category ID.
category_id: u64,
/// Topic title.
#[arg(long, short = 't')]
title: String,
/// Input file path. Reads stdin when omitted or `-`.
local_path: Option<PathBuf>,
},
}
#[derive(Subcommand)]
pub enum CategoryCommand {
/// List categories.
#[command(visible_alias = "ls")]
List {
/// Discourse name.
discourse: String,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
/// Include additional fields where supported.
#[arg(long, short = 'v')]
verbose: bool,
/// Show category hierarchy tree.
#[arg(long)]
tree: bool,
},
/// Copy a category to another Discourse.
#[command(visible_alias = "cp")]
Copy {
/// Source discourse name.
discourse: String,
/// Target discourse name (defaults to source when omitted).
#[arg(long, short = 't')]
target: Option<String>,
/// Category ID or slug.
category: String,
},
/// Pull all topics from a category into local Markdown files.
#[command(visible_alias = "pl")]
Pull {
/// Discourse name.
discourse: String,
/// Category ID or slug.
category: String,
/// Destination directory (auto-derived when omitted).
local_path: Option<PathBuf>,
},
/// Push local Markdown files into a category.
#[command(visible_alias = "ps")]
Push {
/// Discourse name.
discourse: String,
/// Category ID or slug.
category: String,
/// Local directory containing Markdown files.
local_path: PathBuf,
},
}
#[derive(Subcommand)]
pub enum GroupCommand {
/// List groups.
#[command(visible_alias = "ls")]
List {
/// Discourse name.
discourse: String,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
/// Include additional fields where supported.
#[arg(long, short = 'v')]
verbose: bool,
},
/// Show group details.
#[command(visible_alias = "i")]
Info {
/// Discourse name.
discourse: String,
/// Group ID.
group: u64,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "json")]
format: StructuredFormat,
},
/// List members of a group.
#[command(visible_alias = "m")]
Members {
/// Discourse name.
discourse: String,
/// Group ID.
group: u64,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
},
/// Copy a group to another Discourse.
#[command(visible_alias = "cp")]
Copy {
/// Source discourse name.
discourse: String,
/// Target discourse name (defaults to source when omitted).
#[arg(long, short = 't')]
target: Option<String>,
/// Group ID.
group: u64,
},
/// Bulk add members to a group from a file (or stdin) of email addresses.
#[command(visible_alias = "a")]
Add {
/// Discourse name.
discourse: String,
/// Group ID.
group: u64,
/// Path to a file of email addresses (one per line; blank
/// lines and `#` comments are ignored). Reads stdin when
/// omitted or `-`.
local_path: Option<PathBuf>,
/// Send Discourse notifications to added users.
#[arg(long)]
notify: bool,
},
}
#[derive(Subcommand)]
pub enum BackupCommand {
/// Create a new backup.
#[command(visible_alias = "cr")]
Create {
/// Discourse name.
discourse: String,
},
/// List backups.
#[command(visible_alias = "ls")]
List {
/// Discourse name.
discourse: String,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: OutputFormat,
/// Include additional fields where supported.
#[arg(long, short = 'v')]
verbose: bool,
},
/// Restore a backup.
#[command(visible_alias = "rs")]
Restore {
/// Discourse name.
discourse: String,
/// Backup filename/path on the target system.
backup_path: String,
},
}
#[derive(Subcommand)]
pub enum PaletteCommand {
/// List color palettes.
#[command(visible_alias = "ls")]
List {
/// Discourse name.
discourse: String,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
/// Include additional fields where supported.
#[arg(long, short = 'v')]
verbose: bool,
},
/// Pull a palette to local JSON.
#[command(visible_alias = "pl")]
Pull {
/// Discourse name.
discourse: String,
/// Palette ID.
palette_id: u64,
/// Destination file path (auto-derived when omitted).
local_path: Option<PathBuf>,
},
/// Push local JSON to create or update a palette.
#[command(visible_alias = "ps")]
Push {
/// Discourse name.
discourse: String,
/// Local JSON file path.
local_path: PathBuf,
/// Palette ID to update (creates a new palette when omitted).
palette_id: Option<u64>,
},
}
#[derive(Subcommand)]
pub enum PluginCommand {
/// List installed plugins.
#[command(visible_alias = "ls")]
List {
/// Discourse name.
discourse: String,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
/// Include additional fields where supported.
#[arg(long, short = 'v')]
verbose: bool,
},
/// Install a plugin from URL.
#[command(visible_alias = "i")]
Install {
/// Discourse name.
discourse: String,
/// Plugin repository URL.
url: String,
},
/// Remove a plugin by name.
#[command(visible_alias = "rm")]
Remove {
/// Discourse name.
discourse: String,
/// Plugin name.
name: String,
},
}
#[derive(Subcommand)]
pub enum ThemeCommand {
/// List installed themes.
#[command(visible_alias = "ls")]
List {
/// Discourse name.
discourse: String,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
/// Include additional fields where supported.
#[arg(long, short = 'v')]
verbose: bool,
},
/// Install a theme from URL.
#[command(visible_alias = "i")]
Install {
/// Discourse name.
discourse: String,
/// Theme repository URL.
url: String,
},
/// Remove a theme by name.
#[command(visible_alias = "rm")]
Remove {
/// Discourse name.
discourse: String,
/// Theme name.
name: String,
},
/// Pull a theme to a local JSON file.
#[command(visible_alias = "pl")]
Pull {
/// Discourse name.
discourse: String,
/// Theme ID (from `dsc theme list`).
theme_id: u64,
/// Destination file path (auto-derived from theme name when omitted).
local_path: Option<PathBuf>,
},
/// Push a local JSON file to create or update a theme.
#[command(visible_alias = "ps")]
Push {
/// Discourse name.
discourse: String,
/// Local JSON file path.
local_path: PathBuf,
/// Theme ID to update (creates a new theme when omitted).
theme_id: Option<u64>,
},
/// Duplicate a theme and print the new theme ID.
#[command(visible_alias = "dup")]
Duplicate {
/// Discourse name.
discourse: String,
/// Theme ID to duplicate (from `dsc theme list`).
theme_id: u64,
},
}
#[derive(Subcommand)]
pub enum UserCommand {
/// Manage a user's group memberships.
#[command(visible_alias = "g")]
Groups {
#[command(subcommand)]
command: UserGroupsCommand,
},
}
#[derive(Subcommand)]
pub enum UserGroupsCommand {
/// List the groups a user belongs to.
#[command(visible_alias = "ls")]
List {
/// Discourse name.
discourse: String,
/// Target username.
username: String,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
},
/// Add a user to a group.
#[command(visible_alias = "a")]
Add {
/// Discourse name.
discourse: String,
/// Target username.
username: String,
/// Group ID.
group_id: u64,
/// Send Discourse notification to the user.
#[arg(long)]
notify: bool,
},
/// Remove a user from a group.
#[command(visible_alias = "rm")]
Remove {
/// Discourse name.
discourse: String,
/// Target username.
username: String,
/// Group ID.
group_id: u64,
},
}
#[derive(Subcommand)]
pub enum PostCommand {
/// Edit a post by ID. Reads the new body from file or stdin.
#[command(visible_alias = "e")]
Edit {
/// Discourse name.
discourse: String,
/// Post ID.
post_id: u64,
/// Input file path. Reads stdin when omitted or `-`.
local_path: Option<PathBuf>,
},
/// Delete a post by ID.
#[command(visible_alias = "rm")]
Delete {
/// Discourse name.
discourse: String,
/// Post ID.
post_id: u64,
},
/// Move a post to a different topic.
#[command(visible_alias = "mv")]
Move {
/// Discourse name.
discourse: String,
/// Post ID to move.
post_id: u64,
/// Destination topic ID.
#[arg(long = "to-topic", short = 't')]
to_topic: u64,
},
}
#[derive(Subcommand)]
pub enum TagCommand {
/// List every tag on the Discourse.
#[command(visible_alias = "ls")]
List {
/// Discourse name.
discourse: String,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
},
/// Add a tag to a topic.
#[command(visible_alias = "a")]
Apply {
/// Discourse name.
discourse: String,
/// Topic ID.
topic_id: u64,
/// Tag to add.
tag: String,
},
/// Remove a tag from a topic.
#[command(visible_alias = "rm")]
Remove {
/// Discourse name.
discourse: String,
/// Topic ID.
topic_id: u64,
/// Tag to remove.
tag: String,
},
}
#[derive(Subcommand)]
pub enum SettingCommand {
/// Set a site setting on a Discourse (or all tagged Discourses).
#[command(visible_alias = "s")]
Set {
/// Discourse name. Required when targeting a single discourse.
discourse: String,
/// Setting key.
setting: String,
/// Setting value.
value: String,
/// Optional tag filter (comma/semicolon separated, match-any). Ignored when discourse is specified.
#[arg(long, value_name = "tag1,tag2")]
tags: Option<String>,
},
/// Get the current value of a site setting.
#[command(visible_alias = "g")]
Get {
/// Discourse name.
discourse: String,
/// Setting key.
setting: String,
},
/// List all site settings.
#[command(visible_alias = "ls")]
List {
/// Discourse name.
discourse: String,
/// Output format.
#[arg(long, short = 'f', value_enum, default_value = "text")]
format: ListFormat,
/// Show output even when list is empty.
#[arg(long, short = 'v')]
verbose: bool,
},
}
#[derive(ValueEnum, Clone, Copy)]
pub enum CompletionShell {
/// Bash shell.
Bash,
/// Zsh shell.
Zsh,
/// Fish shell.
Fish,
}
impl From<CompletionShell> for Shell {
fn from(value: CompletionShell) -> Self {
match value {
CompletionShell::Bash => Shell::Bash,
CompletionShell::Zsh => Shell::Zsh,
CompletionShell::Fish => Shell::Fish,
}
}
}
#[derive(ValueEnum, Clone)]
pub enum OutputFormat {
/// Plain text.
#[value(alias = "plaintext")]
Text,
/// Markdown list.
Markdown,
/// Markdown table.
MarkdownTable,
/// Pretty JSON.
Json,
/// YAML.
#[value(alias = "yml")]
Yaml,
/// CSV.
Csv,
/// One base URL per line (pipe-friendly).
#[value(alias = "url")]
Urls,
}
#[derive(ValueEnum, Clone, Copy)]
pub enum ListFormat {
/// Plain text.
Text,
/// Pretty JSON.
Json,
/// YAML.
#[value(alias = "yml")]
Yaml,
}
#[derive(ValueEnum, Clone, Copy)]
pub enum StructuredFormat {
/// Pretty JSON.
Json,
/// YAML.
#[value(alias = "yml")]
Yaml,
}