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

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