kanban-cli 0.5.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
use clap::{Args, Parser, Subcommand};
use uuid::Uuid;

use kanban_core::VERSION;

#[derive(Parser)]
#[command(name = "kanban")]
#[command(about = "A terminal-based kanban board", long_about = None)]
#[command(version = VERSION, 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),
    /// 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),
}

// 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 ID
    Get {
        /// Board ID
        id: Uuid,
    },
    /// Update a board
    Update(BoardUpdateArgs),
    /// Delete a board by ID
    Delete {
        /// Board ID
        id: Uuid,
    },
}

#[derive(Args)]
pub struct BoardUpdateArgs {
    /// Board ID to update
    pub id: Uuid,
    #[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>,
}

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

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

#[derive(Args)]
pub struct ColumnUpdateArgs {
    /// Column ID to update
    pub id: Uuid,
    #[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 ID or identifier (e.g. KAN-5)
    Get {
        /// Card UUID or identifier like KAN-5 or 5
        id: String,
    },
    /// Update a card
    Update(CardUpdateArgs),
    /// Move a card to another column
    Move {
        /// Card UUID or identifier like KAN-5 or 5
        id: String,
        #[arg(long)]
        column_id: Uuid,
        #[arg(long)]
        position: Option<i32>,
    },
    /// Archive a card by ID or identifier (e.g. KAN-5)
    Archive {
        /// Card UUID or identifier like KAN-5 or 5
        id: String,
    },
    /// Restore an archived card by ID or identifier (e.g. KAN-5)
    Restore {
        /// Card UUID or identifier like KAN-5 or 5
        id: String,
        #[arg(long)]
        column_id: Option<Uuid>,
    },
    /// Permanently delete an archived card by ID or identifier (e.g. KAN-5)
    Delete {
        /// Card UUID or identifier like KAN-5 or 5
        id: String,
    },
    /// Assign a card to a sprint
    AssignSprint {
        /// Card UUID or identifier like KAN-5 or 5
        id: String,
        #[arg(long)]
        sprint_id: Uuid,
    },
    /// Unassign a card from its sprint
    UnassignSprint {
        /// Card UUID or identifier like KAN-5 or 5
        id: String,
    },
    /// Get the branch name for a card
    BranchName {
        /// Card UUID or identifier like KAN-5 or 5
        id: String,
    },
    /// Get the git checkout command for a card
    GitCheckout {
        /// Card UUID or identifier like KAN-5 or 5
        id: String,
    },
    /// Archive multiple cards
    #[command(name = "archive-cards")]
    ArchiveCards {
        #[arg(long, value_delimiter = ',')]
        ids: Vec<Uuid>,
    },
    /// Move multiple cards to a column
    #[command(name = "move-cards")]
    MoveCards {
        #[arg(long, value_delimiter = ',')]
        ids: Vec<Uuid>,
        #[arg(long)]
        column_id: Uuid,
    },
    /// Assign multiple cards to a sprint
    #[command(name = "assign-cards-to-sprint")]
    AssignCardsToSprint {
        #[arg(long, value_delimiter = ',')]
        ids: Vec<Uuid>,
        #[arg(long)]
        sprint_id: Uuid,
    },
}

#[derive(Args)]
pub struct CardCreateArgs {
    #[arg(long)]
    pub board_id: Uuid,
    #[arg(long)]
    pub column_id: Uuid,
    #[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>,
}

#[derive(Args)]
pub struct CardListArgs {
    #[arg(long)]
    pub board_id: Option<Uuid>,
    #[arg(long)]
    pub column_id: Option<Uuid>,
    #[arg(long)]
    pub sprint_id: Option<Uuid>,
    #[arg(long)]
    pub status: Option<String>,
    #[arg(long)]
    pub archived: bool,
    #[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 id: 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 {
        #[arg(long)]
        board_id: Uuid,
        #[arg(long)]
        prefix: Option<String>,
        #[arg(long)]
        name: Option<String>,
    },
    /// List sprints for a board
    List {
        #[arg(long)]
        board_id: Uuid,
        #[arg(long)]
        page: Option<u32>,
        #[arg(long)]
        page_size: Option<u32>,
    },
    /// Get a specific sprint by ID
    Get {
        /// Sprint ID
        id: Uuid,
    },
    /// Update a sprint
    Update(SprintUpdateArgs),
    /// Activate a sprint by ID
    Activate {
        /// Sprint ID
        id: Uuid,
        #[arg(long)]
        duration_days: Option<i32>,
    },
    /// Complete a sprint by ID
    Complete {
        /// Sprint ID
        id: Uuid,
    },
    /// Cancel a sprint by ID
    Cancel {
        /// Sprint ID
        id: Uuid,
    },
    /// Delete a sprint by ID
    Delete {
        /// Sprint ID
        id: Uuid,
    },
    /// Carry over uncompleted cards from a completed sprint to a planning sprint
    CarryOver {
        /// ID of the completed sprint to carry cards from
        #[arg(long)]
        from: Uuid,
        /// ID of the planning sprint to carry cards to
        #[arg(long)]
        to: Uuid,
    },
}

#[derive(Args)]
pub struct SprintUpdateArgs {
    /// Sprint ID to update
    pub id: Uuid,
    #[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 {
    #[arg(long)]
    pub board_id: Option<Uuid>,
}

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