nmode's Git Repositories - signal-cli/blob - client/src/cli.rs

   1 use clap::{crate_version, Parser, Subcommand, ValueEnum};
   2 use std::{ffi::OsString, net::SocketAddr};
   3
   4 /// JSON-RPC client for signal-cli
   5 #[derive(Parser, Debug)]
   6 #[command(rename_all = "kebab-case", version=crate_version!())]
   7 pub struct Cli {
   8     /// Account to use (for daemon in multi-account mode)
   9     #[arg(short = 'a', long)]
  10     pub account: Option<String>,
  11
  12     /// TCP host and port of signal-cli daemon
  13     #[arg(long, conflicts_with = "json_rpc_http")]
  14     pub json_rpc_tcp: Option<Option<SocketAddr>>,
  15
  16     /// UNIX socket address and port of signal-cli daemon
  17     #[arg(long, conflicts_with = "json_rpc_tcp")]
  18     pub json_rpc_socket: Option<Option<OsString>>,
  19
  20     /// HTTP URL of signal-cli daemon
  21     #[arg(long, conflicts_with = "json_rpc_socket")]
  22     pub json_rpc_http: Option<Option<String>>,
  23
  24     #[arg(value_enum, long, default_value_t = OutputTypes::Json)]
  25     pub output: OutputTypes,
  26
  27     #[arg(long)]
  28     pub verbose: bool,
  29
  30     #[command(subcommand)]
  31     pub command: CliCommands,
  32 }
  33
  34 #[derive(ValueEnum, Clone, Debug)]
  35 #[value(rename_all = "kebab-case")]
  36 pub enum OutputTypes {
  37     PlainText,
  38     Json,
  39 }
  40
  41 #[allow(clippy::large_enum_variant)]
  42 #[derive(Subcommand, Debug)]
  43 #[command(rename_all = "camelCase", version=crate_version!())]
  44 pub enum CliCommands {
  45     AddDevice {
  46         #[arg(long)]
  47         uri: String,
  48     },
  49     #[command(rename_all = "kebab-case")]
  50     Block {
  51         recipient: Vec<String>,
  52
  53         #[arg(short = 'g', long)]
  54         group_id: Vec<String>,
  55     },
  56     DeleteLocalAccountData {
  57         #[arg(long = "ignore-registered")]
  58         ignore_registered: Option<bool>,
  59     },
  60     GetUserStatus {
  61         recipient: Vec<String>,
  62     },
  63     JoinGroup {
  64         #[arg(long)]
  65         uri: String,
  66     },
  67     Link {
  68         #[arg(short = 'n', long)]
  69         name: String,
  70     },
  71     ListAccounts,
  72     ListContacts {
  73         recipient: Vec<String>,
  74         #[arg(short = 'a', long = "all-recipients")]
  75         all_recipients: bool,
  76         #[arg(long)]
  77         blocked: Option<bool>,
  78         #[arg(long)]
  79         name: Option<String>,
  80     },
  81     ListDevices,
  82     ListGroups {
  83         #[arg(short = 'd', long)]
  84         detailed: bool,
  85         #[arg(short = 'g', long = "group-id")]
  86         group_id: Vec<String>,
  87     },
  88     ListIdentities {
  89         #[arg(short = 'n', long)]
  90         number: Option<String>,
  91     },
  92     ListStickerPacks,
  93     QuitGroup {
  94         #[arg(short = 'g', long = "group-id")]
  95         group_id: String,
  96         #[arg(long)]
  97         delete: bool,
  98         #[arg(long)]
  99         admin: Vec<String>,
 100     },
 101     Receive {
 102         #[arg(short = 't', long, default_value_t = 3.0)]
 103         timeout: f64,
 104     },
 105     Register {
 106         #[arg(short = 'v', long)]
 107         voice: bool,
 108         #[arg(long)]
 109         captcha: Option<String>,
 110     },
 111     RemoveContact {
 112         recipient: String,
 113         #[arg(long)]
 114         forget: bool,
 115     },
 116     RemoveDevice {
 117         #[arg(short = 'd', long = "device-id")]
 118         device_id: u32,
 119     },
 120     RemovePin,
 121     RemoteDelete {
 122         #[arg(short = 't', long = "target-timestamp")]
 123         target_timestamp: u64,
 124
 125         recipient: Vec<String>,
 126
 127         #[arg(short = 'g', long = "group-id")]
 128         group_id: Vec<String>,
 129
 130         #[arg(long = "note-to-self")]
 131         note_to_self: bool,
 132     },
 133     #[command(rename_all = "kebab-case")]
 134     Send {
 135         recipient: Vec<String>,
 136
 137         #[arg(short = 'g', long)]
 138         group_id: Vec<String>,
 139
 140         #[arg(long)]
 141         note_to_self: bool,
 142
 143         #[arg(short = 'e', long)]
 144         end_session: bool,
 145
 146         #[arg(short = 'm', long)]
 147         message: Option<String>,
 148
 149         #[arg(short = 'a', long)]
 150         attachment: Vec<String>,
 151
 152         #[arg(long)]
 153         mention: Vec<String>,
 154
 155         #[arg(long)]
 156         quote_timestamp: Option<u64>,
 157
 158         #[arg(long)]
 159         quote_author: Option<String>,
 160
 161         #[arg(long)]
 162         quote_message: Option<String>,
 163
 164         #[arg(long)]
 165         quote_mention: Vec<String>,
 166
 167         #[arg(long)]
 168         sticker: Option<String>,
 169
 170         #[arg(long)]
 171         story_timestamp: Option<u64>,
 172
 173         #[arg(long)]
 174         story_author: Option<String>,
 175     },
 176     SendContacts,
 177     SendPaymentNotification {
 178         recipient: String,
 179
 180         #[arg(long)]
 181         receipt: String,
 182
 183         #[arg(long)]
 184         note: String,
 185     },
 186     SendReaction {
 187         recipient: Vec<String>,
 188
 189         #[arg(short = 'g', long = "group-id")]
 190         group_id: Vec<String>,
 191
 192         #[arg(long = "note-to-self")]
 193         note_to_self: bool,
 194
 195         #[arg(short = 'e', long)]
 196         emoji: String,
 197
 198         #[arg(short = 'a', long = "target-author")]
 199         target_author: String,
 200
 201         #[arg(short = 't', long = "target-timestamp")]
 202         target_timestamp: u64,
 203
 204         #[arg(short = 'r', long)]
 205         remove: bool,
 206
 207         #[arg(long)]
 208         story: bool,
 209     },
 210     SendReceipt {
 211         recipient: String,
 212
 213         #[arg(short = 't', long = "target-timestamp")]
 214         target_timestamp: Vec<u64>,
 215
 216         #[arg(value_enum, long)]
 217         r#type: ReceiptType,
 218     },
 219     SendSyncRequest,
 220     SendTyping {
 221         recipient: Vec<String>,
 222
 223         #[arg(short = 'g', long = "group-id")]
 224         group_id: Vec<String>,
 225
 226         #[arg(short = 's', long)]
 227         stop: bool,
 228     },
 229     SetPin {
 230         pin: String,
 231     },
 232     SubmitRateLimitChallenge {
 233         challenge: String,
 234         captcha: String,
 235     },
 236     Trust {
 237         recipient: String,
 238
 239         #[arg(short = 'a', long = "trust-all-known-keys")]
 240         trust_all_known_keys: bool,
 241
 242         #[arg(short = 'v', long = "verified-safety-number")]
 243         verified_safety_number: Option<String>,
 244     },
 245     #[command(rename_all = "kebab-case")]
 246     Unblock {
 247         recipient: Vec<String>,
 248
 249         #[arg(short = 'g', long)]
 250         group_id: Vec<String>,
 251     },
 252     Unregister {
 253         #[arg(long = "delete-account")]
 254         delete_account: bool,
 255     },
 256     UpdateAccount {
 257         #[arg(short = 'n', long = "device-name")]
 258         device_name: Option<String>,
 259     },
 260     UpdateConfiguration {
 261         #[arg(long = "read-receipts")]
 262         read_receipts: Option<bool>,
 263
 264         #[arg(long = "unidentified-delivery-indicators")]
 265         unidentified_delivery_indicators: Option<bool>,
 266
 267         #[arg(long = "typing-indicators")]
 268         typing_indicators: Option<bool>,
 269
 270         #[arg(long = "link-previews")]
 271         link_previews: Option<bool>,
 272     },
 273     UpdateContact {
 274         recipient: String,
 275
 276         #[arg(short = 'e', long)]
 277         expiration: Option<u32>,
 278
 279         #[arg(short = 'n', long)]
 280         name: Option<String>,
 281     },
 282     UpdateGroup {
 283         #[arg(short = 'g', long = "group-id")]
 284         group_id: Option<String>,
 285
 286         #[arg(short = 'n', long)]
 287         name: Option<String>,
 288
 289         #[arg(short = 'd', long)]
 290         description: Option<String>,
 291
 292         #[arg(short = 'a', long)]
 293         avatar: Option<String>,
 294
 295         #[arg(short = 'm', long)]
 296         member: Vec<String>,
 297
 298         #[arg(short = 'r', long = "remove-member")]
 299         remove_member: Vec<String>,
 300
 301         #[arg(long)]
 302         admin: Vec<String>,
 303
 304         #[arg(long = "remove-admin")]
 305         remove_admin: Vec<String>,
 306
 307         #[arg(long)]
 308         ban: Vec<String>,
 309
 310         #[arg(long)]
 311         unban: Vec<String>,
 312
 313         #[arg(long = "reset-link")]
 314         reset_link: bool,
 315
 316         #[arg(value_enum, long)]
 317         link: Option<LinkState>,
 318
 319         #[arg(value_enum, long = "set-permission-add-member")]
 320         set_permission_add_member: Option<GroupPermission>,
 321
 322         #[arg(value_enum, long = "set-permission-edit-details")]
 323         set_permission_edit_details: Option<GroupPermission>,
 324
 325         #[arg(value_enum, long = "set-permission-send-messages")]
 326         set_permission_send_messages: Option<GroupPermission>,
 327
 328         #[arg(short = 'e', long)]
 329         expiration: Option<u32>,
 330     },
 331     UpdateProfile {
 332         #[arg(long = "given-name")]
 333         given_name: Option<String>,
 334
 335         #[arg(long = "family-name")]
 336         family_name: Option<String>,
 337
 338         #[arg(long)]
 339         about: Option<String>,
 340
 341         #[arg(long = "about-emoji")]
 342         about_emoji: Option<String>,
 343
 344         #[arg(long = "mobile-coin-address")]
 345         mobile_coin_address: Option<String>,
 346
 347         #[arg(long)]
 348         avatar: Option<String>,
 349
 350         #[arg(long = "remove-avatar")]
 351         remove_avatar: bool,
 352     },
 353     UploadStickerPack {
 354         path: String,
 355     },
 356     Verify {
 357         verification_code: String,
 358
 359         #[arg(short = 'p', long)]
 360         pin: Option<String>,
 361     },
 362     Version,
 363 }
 364
 365 #[derive(ValueEnum, Clone, Debug)]
 366 #[value(rename_all = "kebab-case")]
 367 pub enum ReceiptType {
 368     Read,
 369     Viewed,
 370 }
 371
 372 #[derive(ValueEnum, Clone, Debug)]
 373 #[value(rename_all = "kebab-case")]
 374 pub enum LinkState {
 375     Enabled,
 376     EnabledWithApproval,
 377     Disabled,
 378 }
 379
 380 #[derive(ValueEnum, Clone, Debug)]
 381 #[value(rename_all = "kebab-case")]
 382 pub enum GroupPermission {
 383     EveryMember,
 384     OnlyAdmins,
 385 }