`wacli` provides extensive commands for managing your WhatsApp contacts and groups directly from the command line. This includes searching your local database for synced metadata, refreshing informati
wacli provides extensive commands for managing your WhatsApp contacts and groups directly from the command line. This includes searching your local database for synced metadata, refreshing information live from WhatsApp, and performing various administrative actions on groups.
For general installation and authentication instructions, refer to the [Getting Started] page. Remember to replace pnpm wacli with your installed executable path (e.g., ./dist/wacli or wacli if in your PATH).
The wacli contacts command allows you to search for contacts stored in your local database, view their details, refresh their information from WhatsApp, and manage custom aliases and tags.
Searches your local wacli database for contacts based on a query. This search operates on synced metadata like names, phone numbers, and any local aliases you've set.
query: The string to search for.--limit: (Optional) Limit the number of results (default: 50).Displays detailed information for a single contact, including their JID, phone number, names (push, full, first, business), local alias, and any tags.
--jid: The JID (Jabber ID) of the contact (e.g., [email protected]). This flag is required.Imports or updates contact information from the underlying whatsmeow session store into your local wacli database. This ensures your local contact data is up-to-date with your WhatsApp account. Requires an authenticated and connected session.
wacli allows you to set and remove local aliases for your contacts, which are stored solely within your wacli database and help with identification.
Assigns a custom alias to a contact.
--jid: The contact's JID. This flag is required.--alias: The new alias for the contact. This flag is required.Removes an existing alias for a contact.
--jid: The contact's JID. This flag is required.You can categorize contacts with custom tags stored in your local wacli database.
Adds a tag to a contact. A contact can have multiple tags.
--jid: The contact's JID. This flag is required.--tag: The tag to add. This flag is required.Removes a tag from a contact.
--jid: The contact's JID. This flag is required.--tag: The tag to remove. This flag is required.The wacli groups command provides tools for listing, refreshing, viewing details, and managing various aspects of your WhatsApp groups, including participants and invite links.
Lists groups known in your local wacli database. Run wacli sync or wacli groups refresh to populate this data.
--query: (Optional) Search query to filter groups by name or JID.--limit: (Optional) Limit the number of results (default: 50).Fetches a live list of all groups you are currently joined to on WhatsApp and updates their information in your local wacli database. Requires an authenticated and connected session.
Fetches detailed information for a specific group directly from WhatsApp. This includes the group name, owner, creation date, and current participants. This also updates your local DB. Requires an authenticated and connected session.
--jid: The JID of the group (e.g., [email protected]). This flag is required.Changes the name of a specified group on WhatsApp. Requires admin privileges in the group. Requires an authenticated and connected session.
--jid: The group's JID. This flag is required.--name: The new name for the group. This flag is required.These commands allow you to add, remove, promote, or demote participants in a group. Requires admin privileges in the group. Requires an authenticated and connected session.
Adds one or more users to a group.
--jid: The group's JID. This flag is required.--user: The phone number or JID of the user(s) to add. This flag can be repeated for multiple users and is required.Removes one or more users from a group.
--jid: The group's JID. This flag is required.--user: The phone number or JID of the user(s) to remove. This flag can be repeated and is required.Promotes one or more users to administrators within a group.
--jid: The group's JID. This flag is required.--user: The phone number or JID of the user(s) to promote. This flag can be repeated and is required.Demotes one or more administrators to regular members within a group.
--jid: The group's JID. This flag is required.--user: The phone number or JID of the user(s) to demote. This flag can be repeated and is required.Allows you to retrieve or revoke invite links for a group. Requires admin privileges in the group. Requires an authenticated and connected session.
Retrieves the current invite link for a group.
--jid: The group's JID. This flag is required.Generates a new invite link for a group, invalidating the previous one.
--jid: The group's JID. This flag is required.Joins a WhatsApp group using an invite code (the alphanumeric string found in an invite link). Requires an authenticated and connected session.
--code: The invite code from the group link. This flag is required.Leaves a specified WhatsApp group. Requires an authenticated and connected session.
--jid: The JID of the group to leave. This flag is required.