]> nmode's Git Repositories - signal-cli/blobdiff - client/src/cli.rs
git.nmode.ca / signal-cli / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Add support for sending view once messages
[signal-cli] / client / src / cli.rs
diff --git a/client/src/cli.rs b/client/src/cli.rs
index bc6a3079f8ae3caa0c6269f6881e1d2325d3a0d5..7fa5d1c5987aae15d62f9df66b27eb714d052411 100644 (file)
--- a/client/src/cli.rs
+++ b/client/src/cli.rs
@@ -1,198 +1,306 @@
-use clap::{crate_version, ArgEnum, Parser, Subcommand};
 use std::{ffi::OsString, net::SocketAddr};
 
 use std::{ffi::OsString, net::SocketAddr};
 
+use clap::{crate_version, Parser, Subcommand, ValueEnum};
+
 /// JSON-RPC client for signal-cli
 #[derive(Parser, Debug)]
 /// JSON-RPC client for signal-cli
 #[derive(Parser, Debug)]
-#[clap(rename_all = "kebab-case", version=crate_version!())]
+#[command(rename_all = "kebab-case", version = crate_version!())]
 pub struct Cli {
     /// Account to use (for daemon in multi-account mode)
 pub struct Cli {
     /// Account to use (for daemon in multi-account mode)
-    #[clap(short = 'a', long)]
+    #[arg(short = 'a', long)]
     pub account: Option<String>,
 
     /// TCP host and port of signal-cli daemon
     pub account: Option<String>,
 
     /// TCP host and port of signal-cli daemon
-    #[clap(long)]
+    #[arg(long, conflicts_with = "json_rpc_http")]
     pub json_rpc_tcp: Option<Option<SocketAddr>>,
 
     /// UNIX socket address and port of signal-cli daemon
     pub json_rpc_tcp: Option<Option<SocketAddr>>,
 
     /// UNIX socket address and port of signal-cli daemon
-    #[clap(long)]
+    #[cfg(unix)]
+    #[arg(long, conflicts_with = "json_rpc_tcp")]
     pub json_rpc_socket: Option<Option<OsString>>,
 
     pub json_rpc_socket: Option<Option<OsString>>,
 
-    #[clap(arg_enum, long, default_value_t = OutputTypes::Json)]
-    pub output: OutputTypes,
+    /// HTTP URL of signal-cli daemon
+    #[arg(long, conflicts_with = "json_rpc_socket")]
+    pub json_rpc_http: Option<Option<String>>,
 
 
-    #[clap(long)]
+    #[arg(long)]
     pub verbose: bool,
 
     pub verbose: bool,
 
-    #[clap(subcommand)]
+    #[command(subcommand)]
     pub command: CliCommands,
 }
 
     pub command: CliCommands,
 }
 
-#[derive(ArgEnum, Clone, Debug)]
-#[clap(rename_all = "kebab-case")]
-pub enum OutputTypes {
-    PlainText,
-    Json,
-}
-
 #[allow(clippy::large_enum_variant)]
 #[derive(Subcommand, Debug)]
 #[allow(clippy::large_enum_variant)]
 #[derive(Subcommand, Debug)]
-#[clap(rename_all = "camelCase", version=crate_version!())]
+#[command(rename_all = "camelCase", version = crate_version!())]
 pub enum CliCommands {
     AddDevice {
 pub enum CliCommands {
     AddDevice {
-        #[clap(long)]
+        #[arg(long)]
         uri: String,
     },
         uri: String,
     },
-    #[clap(rename_all = "kebab-case")]
+    AddStickerPack {
+        #[arg(long)]
+        uri: String,
+    },
+    #[command(rename_all = "kebab-case")]
     Block {
         recipient: Vec<String>,
 
     Block {
         recipient: Vec<String>,
 
-        #[clap(short = 'g', long)]
+        #[arg(short = 'g', long)]
         group_id: Vec<String>,
     },
         group_id: Vec<String>,
     },
+    DeleteLocalAccountData {
+        #[arg(long = "ignore-registered")]
+        ignore_registered: Option<bool>,
+    },
+    FinishChangeNumber {
+        number: String,
+        #[arg(short = 'v', long = "verification-code")]
+        verification_code: String,
+
+        #[arg(short = 'p', long)]
+        pin: Option<String>,
+    },
+    GetAttachment {
+        #[arg(long)]
+        id: String,
+        #[arg(long)]
+        recipient: Option<String>,
+        #[arg(short = 'g', long = "group-id")]
+        group_id: Option<String>,
+    },
+    GetAvatar {
+        #[arg(long)]
+        contact: Option<String>,
+        #[arg(long)]
+        profile: Option<String>,
+        #[arg(short = 'g', long = "group-id")]
+        group_id: Option<String>,
+    },
+    GetSticker {
+        #[arg(long = "pack-id")]
+        pack_id: String,
+        #[arg(long = "sticker-id")]
+        sticker_id: u32,
+    },
     GetUserStatus {
         recipient: Vec<String>,
     GetUserStatus {
         recipient: Vec<String>,
+        #[arg(long)]
+        username: Vec<String>,
     },
     JoinGroup {
     },
     JoinGroup {
-        #[clap(long)]
+        #[arg(long)]
         uri: String,
     },
     Link {
         uri: String,
     },
     Link {
-        #[clap(short = 'n', long)]
+        #[arg(short = 'n', long)]
         name: String,
     },
     ListAccounts,
         name: String,
     },
     ListAccounts,
-    ListContacts,
+    ListContacts {
+        recipient: Vec<String>,
+        #[arg(short = 'a', long = "all-recipients")]
+        all_recipients: bool,
+        #[arg(long)]
+        blocked: Option<bool>,
+        #[arg(long)]
+        name: Option<String>,
+    },
     ListDevices,
     ListGroups {
     ListDevices,
     ListGroups {
-        #[clap(short = 'd', long)]
+        #[arg(short = 'd', long)]
         detailed: bool,
         detailed: bool,
+        #[arg(short = 'g', long = "group-id")]
+        group_id: Vec<String>,
     },
     ListIdentities {
     },
     ListIdentities {
-        #[clap(short = 'n', long)]
+        #[arg(short = 'n', long)]
         number: Option<String>,
     },
     ListStickerPacks,
     QuitGroup {
         number: Option<String>,
     },
     ListStickerPacks,
     QuitGroup {
-        #[clap(short = 'g', long = "group-id")]
+        #[arg(short = 'g', long = "group-id")]
         group_id: String,
         group_id: String,
-        #[clap(long)]
+        #[arg(long)]
         delete: bool,
         delete: bool,
-        #[clap(long)]
+        #[arg(long)]
         admin: Vec<String>,
     },
     Receive {
         admin: Vec<String>,
     },
     Receive {
-        #[clap(short = 't', long, default_value_t = 3.0)]
+        #[arg(short = 't', long, default_value_t = 3.0)]
         timeout: f64,
     },
     Register {
         timeout: f64,
     },
     Register {
-        #[clap(short = 'v', long)]
+        #[arg(short = 'v', long)]
         voice: bool,
         voice: bool,
-        #[clap(long)]
+        #[arg(long)]
         captcha: Option<String>,
     },
     RemoveContact {
         recipient: String,
         captcha: Option<String>,
     },
     RemoveContact {
         recipient: String,
-        #[clap(long)]
+        #[arg(long)]
         forget: bool,
         forget: bool,
+        #[arg(long)]
+        hide: bool,
     },
     RemoveDevice {
     },
     RemoveDevice {
-        #[clap(short = 'd', long = "device-id")]
+        #[arg(short = 'd', long = "device-id")]
         device_id: u32,
     },
     RemovePin,
     RemoteDelete {
         device_id: u32,
     },
     RemovePin,
     RemoteDelete {
-        #[clap(short = 't', long = "target-timestamp")]
+        #[arg(short = 't', long = "target-timestamp")]
         target_timestamp: u64,
 
         recipient: Vec<String>,
 
         target_timestamp: u64,
 
         recipient: Vec<String>,
 
-        #[clap(short = 'g', long = "group-id")]
+        #[arg(short = 'g', long = "group-id")]
         group_id: Vec<String>,
 
         group_id: Vec<String>,
 
-        #[clap(long = "note-to-self")]
+        #[arg(long = "note-to-self")]
         note_to_self: bool,
     },
         note_to_self: bool,
     },
-    #[clap(rename_all = "kebab-case")]
+    #[command(rename_all = "kebab-case")]
     Send {
         recipient: Vec<String>,
 
     Send {
         recipient: Vec<String>,
 
-        #[clap(short = 'g', long)]
+        #[arg(short = 'g', long)]
         group_id: Vec<String>,
 
         group_id: Vec<String>,
 
-        #[clap(long)]
+        #[arg(long)]
         note_to_self: bool,
 
         note_to_self: bool,
 
-        #[clap(short = 'e', long)]
+        #[arg(short = 'e', long)]
         end_session: bool,
 
         end_session: bool,
 
-        #[clap(short = 'm', long)]
+        #[arg(short = 'm', long)]
         message: Option<String>,
 
         message: Option<String>,
 
-        #[clap(short = 'a', long)]
+        #[arg(short = 'a', long)]
         attachment: Vec<String>,
 
         attachment: Vec<String>,
 
-        #[clap(long)]
+        #[arg(long)]
+        view_once: bool,
+
+        #[arg(long)]
         mention: Vec<String>,
 
         mention: Vec<String>,
 
-        #[clap(long)]
+        #[arg(long)]
+        text_style: Vec<String>,
+
+        #[arg(long)]
         quote_timestamp: Option<u64>,
 
         quote_timestamp: Option<u64>,
 
-        #[clap(long)]
+        #[arg(long)]
         quote_author: Option<String>,
 
         quote_author: Option<String>,
 
-        #[clap(long)]
+        #[arg(long)]
         quote_message: Option<String>,
 
         quote_message: Option<String>,
 
-        #[clap(long)]
+        #[arg(long)]
         quote_mention: Vec<String>,
 
         quote_mention: Vec<String>,
 
-        #[clap(long)]
+        #[arg(long)]
+        quote_text_style: Vec<String>,
+
+        #[arg(long)]
+        quote_attachment: Vec<String>,
+
+        #[arg(long)]
+        preview_url: Option<String>,
+
+        #[arg(long)]
+        preview_title: Option<String>,
+
+        #[arg(long)]
+        preview_description: Option<String>,
+
+        #[arg(long)]
+        preview_image: Option<String>,
+
+        #[arg(long)]
         sticker: Option<String>,
         sticker: Option<String>,
+
+        #[arg(long)]
+        story_timestamp: Option<u64>,
+
+        #[arg(long)]
+        story_author: Option<String>,
+
+        #[arg(long)]
+        edit_timestamp: Option<u64>,
     },
     SendContacts,
     },
     SendContacts,
+    SendPaymentNotification {
+        recipient: String,
+
+        #[arg(long)]
+        receipt: String,
+
+        #[arg(long)]
+        note: String,
+    },
     SendReaction {
         recipient: Vec<String>,
 
     SendReaction {
         recipient: Vec<String>,
 
-        #[clap(short = 'g', long = "group-id")]
+        #[arg(short = 'g', long = "group-id")]
         group_id: Vec<String>,
 
         group_id: Vec<String>,
 
-        #[clap(long = "note-to-self")]
+        #[arg(long = "note-to-self")]
         note_to_self: bool,
 
         note_to_self: bool,
 
-        #[clap(short = 'e', long)]
+        #[arg(short = 'e', long)]
         emoji: String,
 
         emoji: String,
 
-        #[clap(short = 'a', long = "target-author")]
+        #[arg(short = 'a', long = "target-author")]
         target_author: String,
 
         target_author: String,
 
-        #[clap(short = 't', long = "target-timestamp")]
+        #[arg(short = 't', long = "target-timestamp")]
         target_timestamp: u64,
 
         target_timestamp: u64,
 
-        #[clap(short = 'r', long)]
+        #[arg(short = 'r', long)]
         remove: bool,
         remove: bool,
+
+        #[arg(long)]
+        story: bool,
     },
     SendReceipt {
         recipient: String,
 
     },
     SendReceipt {
         recipient: String,
 
-        #[clap(short = 't', long = "target-timestamp")]
+        #[arg(short = 't', long = "target-timestamp")]
         target_timestamp: Vec<u64>,
 
         target_timestamp: Vec<u64>,
 
-        #[clap(arg_enum, long)]
+        #[arg(value_enum, long)]
         r#type: ReceiptType,
     },
     SendSyncRequest,
     SendTyping {
         recipient: Vec<String>,
 
         r#type: ReceiptType,
     },
     SendSyncRequest,
     SendTyping {
         recipient: Vec<String>,
 
-        #[clap(short = 'g', long = "group-id")]
+        #[arg(short = 'g', long = "group-id")]
         group_id: Vec<String>,
 
         group_id: Vec<String>,
 
-        #[clap(short = 's', long)]
+        #[arg(short = 's', long)]
         stop: bool,
     },
         stop: bool,
     },
+    SendMessageRequestResponse {
+        recipient: Vec<String>,
+
+        #[arg(short = 'g', long = "group-id")]
+        group_id: Vec<String>,
+
+        r#type: MessageRequestResponseType,
+    },
     SetPin {
         pin: String,
     },
     SetPin {
         pin: String,
     },
+    StartChangeNumber {
+        number: String,
+        #[arg(short = 'v', long)]
+        voice: bool,
+        #[arg(long)]
+        captcha: Option<String>,
+    },
     SubmitRateLimitChallenge {
         challenge: String,
         captcha: String,
     SubmitRateLimitChallenge {
         challenge: String,
         captcha: String,
@@ -200,109 +308,124 @@ pub enum CliCommands {
     Trust {
         recipient: String,
 
     Trust {
         recipient: String,
 
-        #[clap(short = 'a', long = "trust-all-known-keys")]
+        #[arg(short = 'a', long = "trust-all-known-keys")]
         trust_all_known_keys: bool,
 
         trust_all_known_keys: bool,
 
-        #[clap(short = 'v', long = "verified-safety-number")]
+        #[arg(short = 'v', long = "verified-safety-number")]
         verified_safety_number: Option<String>,
     },
         verified_safety_number: Option<String>,
     },
-    #[clap(rename_all = "kebab-case")]
+    #[command(rename_all = "kebab-case")]
     Unblock {
         recipient: Vec<String>,
 
     Unblock {
         recipient: Vec<String>,
 
-        #[clap(short = 'g', long)]
+        #[arg(short = 'g', long)]
         group_id: Vec<String>,
     },
     Unregister {
         group_id: Vec<String>,
     },
     Unregister {
-        #[clap(long = "delete-account")]
+        #[arg(long = "delete-account")]
         delete_account: bool,
     },
     UpdateAccount {
         delete_account: bool,
     },
     UpdateAccount {
-        #[clap(short = 'n', long = "device-name")]
+        #[arg(short = 'n', long = "device-name")]
         device_name: Option<String>,
         device_name: Option<String>,
+        #[arg(long = "unrestricted-unidentified-sender")]
+        unrestricted_unidentified_sender: Option<bool>,
+        #[arg(long = "discoverable-by-number")]
+        discoverable_by_number: Option<bool>,
+        #[arg(long = "number-sharing")]
+        number_sharing: Option<bool>,
     },
     UpdateConfiguration {
     },
     UpdateConfiguration {
-        #[clap(long = "read-receipts", parse(try_from_str))]
+        #[arg(long = "read-receipts")]
         read_receipts: Option<bool>,
 
         read_receipts: Option<bool>,
 
-        #[clap(long = "unidentified-delivery-indicators")]
+        #[arg(long = "unidentified-delivery-indicators")]
         unidentified_delivery_indicators: Option<bool>,
 
         unidentified_delivery_indicators: Option<bool>,
 
-        #[clap(long = "typing-indicators")]
+        #[arg(long = "typing-indicators")]
         typing_indicators: Option<bool>,
 
         typing_indicators: Option<bool>,
 
-        #[clap(long = "link-previews")]
+        #[arg(long = "link-previews")]
         link_previews: Option<bool>,
     },
     UpdateContact {
         recipient: String,
 
         link_previews: Option<bool>,
     },
     UpdateContact {
         recipient: String,
 
-        #[clap(short = 'e', long)]
+        #[arg(short = 'e', long)]
         expiration: Option<u32>,
 
         expiration: Option<u32>,
 
-        #[clap(short = 'n', long)]
+        #[arg(short = 'n', long)]
         name: Option<String>,
     },
     UpdateGroup {
         name: Option<String>,
     },
     UpdateGroup {
-        #[clap(short = 'g', long = "group-id")]
+        #[arg(short = 'g', long = "group-id")]
         group_id: Option<String>,
 
         group_id: Option<String>,
 
-        #[clap(short = 'n', long)]
+        #[arg(short = 'n', long)]
         name: Option<String>,
 
         name: Option<String>,
 
-        #[clap(short = 'd', long)]
+        #[arg(short = 'd', long)]
         description: Option<String>,
 
         description: Option<String>,
 
-        #[clap(short = 'a', long)]
+        #[arg(short = 'a', long)]
         avatar: Option<String>,
 
         avatar: Option<String>,
 
-        #[clap(short = 'm', long)]
+        #[arg(short = 'm', long)]
         member: Vec<String>,
 
         member: Vec<String>,
 
-        #[clap(short = 'r', long = "remove-member")]
+        #[arg(short = 'r', long = "remove-member")]
         remove_member: Vec<String>,
 
         remove_member: Vec<String>,
 
-        #[clap(long)]
+        #[arg(long)]
         admin: Vec<String>,
 
         admin: Vec<String>,
 
-        #[clap(long = "remove-admin")]
+        #[arg(long = "remove-admin")]
         remove_admin: Vec<String>,
 
         remove_admin: Vec<String>,
 
-        #[clap(long = "reset-link")]
+        #[arg(long)]
+        ban: Vec<String>,
+
+        #[arg(long)]
+        unban: Vec<String>,
+
+        #[arg(long = "reset-link")]
         reset_link: bool,
 
         reset_link: bool,
 
-        #[clap(arg_enum, long)]
+        #[arg(value_enum, long)]
         link: Option<LinkState>,
 
         link: Option<LinkState>,
 
-        #[clap(arg_enum, long = "set-permission-add-member")]
+        #[arg(value_enum, long = "set-permission-add-member")]
         set_permission_add_member: Option<GroupPermission>,
 
         set_permission_add_member: Option<GroupPermission>,
 
-        #[clap(arg_enum, long = "set-permission-edit-details")]
+        #[arg(value_enum, long = "set-permission-edit-details")]
         set_permission_edit_details: Option<GroupPermission>,
 
         set_permission_edit_details: Option<GroupPermission>,
 
-        #[clap(arg_enum, long = "set-permission-send-messages")]
+        #[arg(value_enum, long = "set-permission-send-messages")]
         set_permission_send_messages: Option<GroupPermission>,
 
         set_permission_send_messages: Option<GroupPermission>,
 
-        #[clap(short = 'e', long)]
+        #[arg(short = 'e', long)]
         expiration: Option<u32>,
     },
     UpdateProfile {
         expiration: Option<u32>,
     },
     UpdateProfile {
-        #[clap(long = "given-name")]
+        #[arg(long = "given-name")]
         given_name: Option<String>,
 
         given_name: Option<String>,
 
-        #[clap(long = "family-name")]
+        #[arg(long = "family-name")]
         family_name: Option<String>,
 
         family_name: Option<String>,
 
-        #[clap(long)]
+        #[arg(long)]
         about: Option<String>,
 
         about: Option<String>,
 
-        #[clap(long = "about-emoji")]
+        #[arg(long = "about-emoji")]
         about_emoji: Option<String>,
 
         about_emoji: Option<String>,
 
-        #[clap(long)]
+        #[arg(long = "mobile-coin-address", visible_alias = "mobilecoin-address")]
+        mobile_coin_address: Option<String>,
+
+        #[arg(long)]
         avatar: Option<String>,
 
         avatar: Option<String>,
 
-        #[clap(long = "remove-avatar")]
+        #[arg(long = "remove-avatar")]
         remove_avatar: bool,
     },
     UploadStickerPack {
         remove_avatar: bool,
     },
     UploadStickerPack {
@@ -311,30 +434,37 @@ pub enum CliCommands {
     Verify {
         verification_code: String,
 
     Verify {
         verification_code: String,
 
-        #[clap(short = 'p', long)]
+        #[arg(short = 'p', long)]
         pin: Option<String>,
     },
     Version,
 }
 
         pin: Option<String>,
     },
     Version,
 }
 
-#[derive(ArgEnum, Clone, Debug)]
-#[clap(rename_all = "kebab-case")]
+#[derive(ValueEnum, Clone, Debug)]
+#[value(rename_all = "kebab-case")]
 pub enum ReceiptType {
     Read,
     Viewed,
 }
 
 pub enum ReceiptType {
     Read,
     Viewed,
 }
 
-#[derive(ArgEnum, Clone, Debug)]
-#[clap(rename_all = "kebab-case")]
+#[derive(ValueEnum, Clone, Debug)]
+#[value(rename_all = "kebab-case")]
 pub enum LinkState {
     Enabled,
     EnabledWithApproval,
     Disabled,
 }
 
 pub enum LinkState {
     Enabled,
     EnabledWithApproval,
     Disabled,
 }
 
-#[derive(ArgEnum, Clone, Debug)]
-#[clap(rename_all = "kebab-case")]
+#[derive(ValueEnum, Clone, Debug)]
+#[value(rename_all = "kebab-case")]
 pub enum GroupPermission {
     EveryMember,
     OnlyAdmins,
 }
 pub enum GroupPermission {
     EveryMember,
     OnlyAdmins,
 }
+
+#[derive(ValueEnum, Clone, Debug)]
+#[value(rename_all = "kebab-case")]
+pub enum MessageRequestResponseType {
+    Accept,
+    Delete,
+}
[GitHub/AsamK] signal-cli provides an unofficial commandline, JSON-RPC and dbus interface for the Signal messenger.

Codeberg
GitHub
GitLab
SourceHut