kanban-cli 0.7.1

Command-line interface for the kanban project management tool
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
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
use clap::{Args, Parser, Subcommand, ValueEnum};

use kanban_core::CLI_VERSION_DISPLAY;

#[derive(Parser)]
#[command(name = "kanban")]
#[command(about = "A terminal-based kanban board", long_about = None)]
#[command(version = CLI_VERSION_DISPLAY, arg_required_else_help = false)]
pub struct Cli {
    /// Path to kanban data file (or set KANBAN_FILE env var)
    #[arg(value_name = "FILE", env = "KANBAN_FILE")]
    pub file: Option<String>,

    #[command(subcommand)]
    pub command: Option<Commands>,
}

#[derive(Subcommand)]
pub enum Commands {
    /// Board operations
    Board(BoardCommand),
    /// Column operations
    Column(ColumnCommand),
    /// Card operations
    Card(CardCommand),
    /// Card-relation operations (parent/child)
    Relation(RelationCommand),
    /// Sprint operations
    Sprint(SprintCommand),
    /// Export board data
    Export(ExportArgs),
    /// Import board data
    Import(ImportArgs),
    /// Generate shell completions
    Completions {
        #[arg(value_enum)]
        shell: clap_complete::Shell,
    },
    /// Migrate data between storage backends
    Migrate(MigrateArgs),
    /// Initialize a new board file with an optional first board
    Init {
        /// Name of the first board to create. If omitted, the file is created with no entities.
        #[arg(long)]
        board: Option<String>,
    },
}

// Board commands
#[derive(Args)]
pub struct BoardCommand {
    #[command(subcommand)]
    pub action: BoardAction,
}

#[derive(Subcommand)]
pub enum BoardAction {
    /// Create a new board
    Create {
        #[arg(long)]
        name: String,
        #[arg(long)]
        card_prefix: Option<String>,
    },
    /// List all boards
    List {
        #[arg(long)]
        page: Option<u32>,
        #[arg(long)]
        page_size: Option<u32>,
    },
    /// Get a specific board by UUID or name
    Get {
        /// Board UUID or name
        board: String,
    },
    /// Update a board
    Update(BoardUpdateArgs),
    /// Delete a board by UUID or name
    Delete {
        /// Board UUID or name
        board: String,
    },
}

#[derive(Args)]
pub struct BoardUpdateArgs {
    /// Board UUID or name
    pub board: String,
    #[arg(long)]
    pub name: Option<String>,
    #[arg(long)]
    pub description: Option<String>,
    #[arg(long)]
    pub sprint_prefix: Option<String>,
    #[arg(long)]
    pub card_prefix: Option<String>,
    /// Default sort key for the task list view.
    #[arg(long, value_enum)]
    pub sort_field: Option<SortKey>,
    /// Default sort direction for the task list view.
    #[arg(long, value_enum)]
    pub sort_order: Option<SortDir>,
}

// Column commands
#[derive(Args)]
pub struct ColumnCommand {
    #[command(subcommand)]
    pub action: ColumnAction,
}

#[derive(Subcommand)]
pub enum ColumnAction {
    /// Create a new column
    Create {
        /// Board UUID or name
        #[arg(long)]
        board: String,
        #[arg(long)]
        name: String,
        #[arg(long)]
        position: Option<i32>,
    },
    /// List columns for a board
    List {
        /// Board UUID or name
        #[arg(long)]
        board: String,
        #[arg(long)]
        page: Option<u32>,
        #[arg(long)]
        page_size: Option<u32>,
    },
    /// Get a specific column by UUID or name
    Get {
        /// Column UUID or name
        column: String,
    },
    /// Update a column
    Update(ColumnUpdateArgs),
    /// Delete a column by UUID or name
    Delete {
        /// Column UUID or name
        column: String,
    },
    /// Reorder a column by UUID or name
    Reorder {
        /// Column UUID or name
        column: String,
        #[arg(long)]
        position: i32,
    },
}

#[derive(Args)]
pub struct ColumnUpdateArgs {
    /// Column UUID or name
    pub column: String,
    #[arg(long)]
    pub name: Option<String>,
    #[arg(long)]
    pub position: Option<i32>,
    #[arg(long)]
    pub wip_limit: Option<u32>,
    #[arg(long)]
    pub clear_wip_limit: bool,
}

// Card commands
#[derive(Args)]
pub struct CardCommand {
    #[command(subcommand)]
    pub action: CardAction,
}

#[derive(Subcommand)]
pub enum CardAction {
    /// Create a new card
    Create(CardCreateArgs),
    /// List cards with optional filters
    List(CardListArgs),
    /// Get a specific card by UUID or identifier (e.g. KAN-5)
    Get {
        /// Card UUID or identifier like KAN-5 or 5
        card: String,
    },
    /// Update a card
    Update(CardUpdateArgs),
    /// Move a card to another column
    Move {
        /// Card UUID or identifier like KAN-5 or 5
        card: String,
        /// Column UUID or name
        #[arg(long)]
        column: String,
        #[arg(long)]
        position: Option<i32>,
    },
    /// Archive a card by UUID or identifier (e.g. KAN-5)
    Archive {
        /// Card UUID or identifier like KAN-5 or 5
        card: String,
    },
    /// Restore an archived card by UUID or identifier (e.g. KAN-5)
    Restore {
        /// Card UUID or identifier like KAN-5 or 5
        card: String,
        /// Column UUID or name
        #[arg(long)]
        column: Option<String>,
    },
    /// Permanently delete an archived card by UUID or identifier (e.g. KAN-5)
    Delete {
        /// Card UUID or identifier like KAN-5 or 5
        card: String,
    },
    /// Assign a card to a sprint
    AssignSprint {
        /// Card UUID or identifier like KAN-5 or 5
        card: String,
        /// Sprint UUID, name, or number
        #[arg(long)]
        sprint: String,
    },
    /// Unassign a card from its sprint
    UnassignSprint {
        /// Card UUID or identifier like KAN-5 or 5
        card: String,
    },
    /// Get the branch name for a card
    BranchName {
        /// Card UUID or identifier like KAN-5 or 5
        card: String,
    },
    /// Get the git checkout command for a card
    GitCheckout {
        /// Card UUID or identifier like KAN-5 or 5
        card: String,
    },
    /// Archive multiple cards
    #[command(name = "archive-cards")]
    ArchiveCards {
        /// Comma-separated card UUIDs or identifiers (e.g. KAN-1,KAN-2,42)
        #[arg(long, value_delimiter = ',')]
        cards: Vec<String>,
    },
    /// Move multiple cards to a column
    #[command(name = "move-cards")]
    MoveCards {
        /// Comma-separated card UUIDs or identifiers (e.g. KAN-1,KAN-2,42)
        #[arg(long, value_delimiter = ',')]
        cards: Vec<String>,
        /// Column UUID or name (must be on the same board as all selected cards)
        #[arg(long)]
        column: String,
    },
    /// Assign multiple cards to a sprint
    #[command(name = "assign-cards-to-sprint")]
    AssignCardsToSprint {
        /// Comma-separated card UUIDs or identifiers (e.g. KAN-1,KAN-2,42)
        #[arg(long, value_delimiter = ',')]
        cards: Vec<String>,
        /// Sprint UUID, name, or number (must be on the same board as all selected cards)
        #[arg(long)]
        sprint: String,
    },
}

// Relation commands

/// Sort key for `kanban relation parents` / `children` output.
#[derive(Copy, Clone, Debug, ValueEnum)]
pub enum SortKey {
    CardNumber,
    Priority,
    Points,
    CreatedAt,
    UpdatedAt,
    DueDate,
    Status,
    Position,
}

/// Sort direction.
#[derive(Copy, Clone, Debug, ValueEnum)]
pub enum SortDir {
    Asc,
    Desc,
}

impl SortKey {
    pub fn to_sort_by(self) -> kanban_domain::sort::SortBy {
        use kanban_domain::sort::SortBy;
        match self {
            SortKey::CardNumber => SortBy::CardNumber,
            SortKey::Priority => SortBy::Priority,
            SortKey::Points => SortBy::Points,
            SortKey::CreatedAt => SortBy::CreatedAt,
            SortKey::UpdatedAt => SortBy::UpdatedAt,
            SortKey::DueDate => SortBy::DueDate,
            SortKey::Status => SortBy::Status,
            SortKey::Position => SortBy::Position,
        }
    }

    /// Convert a CLI sort flag to the board-level `SortField`. `CardNumber`
    /// has no `SortField` counterpart, so it falls back to `SortField::Default`
    /// which `get_sorter_for_field` also resolves via `SortBy::CardNumber`.
    pub fn to_sort_field(self) -> kanban_domain::SortField {
        use kanban_domain::SortField;
        match self {
            SortKey::CardNumber => SortField::Default,
            SortKey::Priority => SortField::Priority,
            SortKey::Points => SortField::Points,
            SortKey::CreatedAt => SortField::CreatedAt,
            SortKey::UpdatedAt => SortField::UpdatedAt,
            SortKey::DueDate => SortField::DueDate,
            SortKey::Status => SortField::Status,
            SortKey::Position => SortField::Position,
        }
    }
}

impl SortDir {
    pub fn to_sort_order(self) -> kanban_domain::SortOrder {
        match self {
            SortDir::Asc => kanban_domain::SortOrder::Ascending,
            SortDir::Desc => kanban_domain::SortOrder::Descending,
        }
    }
}

#[cfg(test)]
mod sort_key_tests {
    use super::*;
    use kanban_domain::sort::SortBy;
    use kanban_domain::SortField;

    #[test]
    fn test_sort_key_due_date_maps_to_sort_by_due_date() {
        assert!(matches!(SortKey::DueDate.to_sort_by(), SortBy::DueDate));
    }

    #[test]
    fn test_sort_key_due_date_maps_to_sort_field_due_date() {
        assert_eq!(SortKey::DueDate.to_sort_field(), SortField::DueDate);
    }
}

#[derive(Args)]
pub struct RelationCommand {
    #[command(subcommand)]
    pub action: RelationAction,
}

#[derive(Subcommand)]
pub enum RelationAction {
    /// Add parent → child edges between one parent and one or more children
    Add {
        /// Parent card UUID or identifier (e.g. KAN-2)
        parent: String,
        /// One or more child cards (UUID or identifier)
        #[arg(required = true, num_args = 1..)]
        children: Vec<String>,
    },
    /// Remove parent → child edges between one parent and one or more children
    Remove {
        /// Parent card UUID or identifier (e.g. KAN-2)
        parent: String,
        /// One or more child cards (UUID or identifier)
        #[arg(required = true, num_args = 1..)]
        children: Vec<String>,
    },
    /// List direct parents of a card
    Parents {
        /// Card UUID or identifier
        card: String,
        /// Sort key for the returned list
        #[arg(long, value_enum, default_value_t = SortKey::CardNumber)]
        sort: SortKey,
        /// Sort direction
        #[arg(long, value_enum, default_value_t = SortDir::Asc)]
        order: SortDir,
    },
    /// List direct children of a card
    Children {
        /// Card UUID or identifier
        card: String,
        /// Sort key for the returned list
        #[arg(long, value_enum, default_value_t = SortKey::CardNumber)]
        sort: SortKey,
        /// Sort direction
        #[arg(long, value_enum, default_value_t = SortDir::Asc)]
        order: SortDir,
    },
}

#[derive(Args)]
pub struct CardCreateArgs {
    /// Board UUID or name
    #[arg(long)]
    pub board: String,
    /// Column UUID or name
    #[arg(long)]
    pub column: String,
    #[arg(long)]
    pub title: String,
    #[arg(long)]
    pub description: Option<String>,
    #[arg(long)]
    pub priority: Option<String>,
    #[arg(long)]
    pub points: Option<u8>,
    #[arg(long)]
    pub due_date: Option<String>,
    /// Assign the new card to a sprint. Pass a UUID, name, or number to pick a
    /// specific sprint; pass without a value to use the board's sole active
    /// sprint (errors if zero or more than one active sprint exists).
    #[arg(long = "assign", short = 'a', num_args = 0..=1, default_missing_value = "")]
    pub assign_sprint: Option<String>,
}

#[derive(Args)]
pub struct CardListArgs {
    /// Board UUID or name
    #[arg(long)]
    pub board: Option<String>,
    /// Column UUID or name (scoped to --board if given, else searched globally)
    #[arg(long)]
    pub column: Option<String>,
    /// Sprint UUID, name, or number (scoped to --board if given, else searched globally)
    #[arg(long)]
    pub sprint: Option<String>,
    #[arg(long)]
    pub status: Option<String>,
    #[arg(long)]
    pub archived: bool,
    /// Sort key. When omitted, falls back to the board's `task_sort_field`
    /// (requires --board).
    #[arg(long, value_enum)]
    pub sort: Option<SortKey>,
    /// Sort direction. When omitted, falls back to the board's
    /// `task_sort_order` (requires --board).
    #[arg(long, value_enum)]
    pub order: Option<SortDir>,
    #[arg(long)]
    pub page: Option<u32>,
    #[arg(long)]
    pub page_size: Option<u32>,
}

#[derive(Args)]
pub struct CardUpdateArgs {
    /// Card UUID or identifier like KAN-5 or 5
    pub card: String,
    #[arg(long)]
    pub title: Option<String>,
    #[arg(long)]
    pub description: Option<String>,
    #[arg(long)]
    pub priority: Option<String>,
    #[arg(long)]
    pub status: Option<String>,
    #[arg(long)]
    pub points: Option<u8>,
    #[arg(long)]
    pub due_date: Option<String>,
    #[arg(long)]
    pub clear_due_date: bool,
}

// Sprint commands
#[derive(Args)]
pub struct SprintCommand {
    #[command(subcommand)]
    pub action: SprintAction,
}

#[derive(Subcommand)]
pub enum SprintAction {
    /// Create a new sprint
    Create {
        /// Board UUID or name
        #[arg(long)]
        board: String,
        #[arg(long)]
        prefix: Option<String>,
        #[arg(long)]
        name: Option<String>,
    },
    /// List sprints for a board
    List {
        /// Board UUID or name
        #[arg(long)]
        board: String,
        #[arg(long)]
        page: Option<u32>,
        #[arg(long)]
        page_size: Option<u32>,
    },
    /// Get a specific sprint by UUID, name, or number
    Get {
        /// Sprint UUID, name, or number
        sprint: String,
    },
    /// Update a sprint
    Update(SprintUpdateArgs),
    /// Activate a sprint by UUID, name, or number
    Activate {
        /// Sprint UUID, name, or number
        sprint: String,
        #[arg(long)]
        duration_days: Option<i32>,
    },
    /// Complete a sprint by UUID, name, or number
    Complete {
        /// Sprint UUID, name, or number
        sprint: String,
    },
    /// Cancel a sprint by UUID, name, or number
    Cancel {
        /// Sprint UUID, name, or number
        sprint: String,
    },
    /// Delete a sprint by UUID, name, or number
    Delete {
        /// Sprint UUID, name, or number
        sprint: String,
    },
    /// Carry over uncompleted cards from a completed sprint to a planning sprint
    CarryOver {
        /// Source sprint UUID, name, or number (must be completed)
        #[arg(long)]
        from: String,
        /// Target sprint UUID, name, or number (must be in planning; on same board as source)
        #[arg(long)]
        to: String,
    },
}

#[derive(Args)]
pub struct SprintUpdateArgs {
    /// Sprint UUID, name, or number
    pub sprint: String,
    #[arg(long)]
    pub name: Option<String>,
    #[arg(long)]
    pub prefix: Option<String>,
    #[arg(long)]
    pub card_prefix: Option<String>,
    #[arg(long)]
    pub start_date: Option<String>,
    #[arg(long)]
    pub end_date: Option<String>,
    #[arg(long)]
    pub clear_start_date: bool,
    #[arg(long)]
    pub clear_end_date: bool,
}

// Migrate command
#[derive(Args)]
#[command(after_help = "EXAMPLES:
    kanban migrate boards.json sqlite
    kanban migrate boards.json sqlite -o /path/to/output.sqlite
    kanban migrate boards.sqlite json -o boards.json
    kanban migrate data.bin json --source-backend sqlite")]
pub struct MigrateArgs {
    /// Path to source file
    pub source: String,
    /// Target backend name
    pub backend: String,
    /// Output path (default: derived from source filename and target backend)
    #[arg(long, short)]
    pub output: Option<String>,
    /// Override source backend auto-detection
    #[arg(long)]
    pub source_backend: Option<String>,
}

// Export/Import commands
#[derive(Args)]
pub struct ExportArgs {
    /// Board UUID or name; if omitted, exports all boards
    #[arg(long)]
    pub board: Option<String>,
}

#[derive(Args)]
pub struct ImportArgs {
    #[arg(long)]
    pub file: String,
}