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