wekan-cli 0.12.0

Agent-first, human-friendly command-line client for Wekan
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

pub mod api;
pub mod attachments;
pub mod auth;
pub(crate) mod authenticated;
pub mod boards;
pub mod cards;
pub mod checklist_items;
pub mod checklists;
pub(crate) mod client_error;
pub mod comments;
pub(crate) mod credential_ops;
pub mod custom_field_items;
pub mod custom_fields;
pub mod dependencies;
pub mod integrations;
pub mod lists;
pub mod profile;
pub mod swimlanes;
mod transfer;
pub mod users;

#[cfg(test)]
mod tests;

use clap::Subcommand;

#[derive(Debug, Subcommand)]
pub enum RootCommand {
    /// Inspect and manage board integrations and webhook subscriptions.
    Integration(integrations::IntegrationArgs),
    /// Inspect and manage card dependency lines.
    Dependency(dependencies::DependencyArgs),
    /// Inspect, transfer and manage Wekan attachments.
    Attachment(attachments::AttachmentArgs),
    /// Send a low-level request to the selected Wekan server.
    Api(api::ApiArgs),

    /// Authenticate with a Wekan server.
    Auth(auth::AuthArgs),

    /// Manage named local Wekan server profiles.
    Profile(profile::ProfileArgs),

    /// Inspect and administer Wekan users.
    User(users::UserArgs),

    /// Inspect and manage Wekan boards.
    Board(boards::BoardArgs),

    /// Inspect and manage lists on Wekan boards.
    List(lists::ListArgs),

    /// Inspect and manage cards in Wekan board lists.
    Card(Box<cards::CardArgs>),

    /// Inspect and manage checklists on Wekan cards.
    Checklist(checklists::ChecklistArgs),

    /// Inspect and manage checklist items.
    ChecklistItem(checklist_items::ChecklistItemArgs),

    /// Inspect and manage comments on Wekan cards.
    Comment(comments::CommentArgs),

    /// Inspect and manage custom-field definitions.
    CustomField(custom_fields::CustomFieldArgs),

    /// Manage custom-field dropdown items.
    CustomFieldItem(custom_field_items::CustomFieldItemArgs),

    /// Inspect and manage swimlanes on Wekan boards.
    Swimlane(swimlanes::SwimlaneArgs),
}

impl RootCommand {
    pub fn supports_raw_output(&self) -> bool {
        matches!(self, Self::Api(_))
            || matches!(self, Self::Attachment(args) if args.command.download_destination().is_some_and(|d| d.is_stdout()))
    }

    pub fn validate_output(
        &self,
        format: crate::output::OutputFormat,
    ) -> Result<(), crate::error::AppError> {
        if let Self::Attachment(args) = self {
            args.command.validate_input()?;
            if let Some(destination) = args.command.download_destination() {
                destination.validate_output(format)?;
            }
        }
        if format == crate::output::OutputFormat::Raw && !self.supports_raw_output() {
            return Err(crate::error::AppError::invalid_input(
                "--output raw requires api request or an attachment download with --destination -",
            ));
        }
        Ok(())
    }
}