📦 n8n-nodes-signal-cli

This repository contains n8n nodes for interacting with Signal CLI. It includes a trigger node for receiving messages and an action node for various Signal operations.

📚 Table of Contents

1. 📋 Prerequisites
2. 🚀 Usage
3. 📥 Installation
4. 🤖 Nodes
5. 💻 Development
6. 🚀 Release
7. 🤝 Contributing
8. ⚠️ Known Limitations
9. 📄 License

📋 Prerequisites

• Node.js (>=18.10) and pnpm (>=9.1)
• n8n installed globally using pnpm install n8n -g
• Signal CLI set up and running in daemon mode with HTTP JSON-RPC endpoint exposed (--http)

📥 Installation

1. Clone this repository.
2. Run pnpm install to install dependencies.
3. Run pnpm build to build the nodes.
4. Copy the dist folder and package.json to your n8n custom nodes directory (usually ~/.n8n/custom/nodes/n8n-nodes-signal-cli).

🤖 Nodes

🔔 SignalTrigger

• Triggers when a new message is received via Signal CLI.
• Requires Signal CLI API credential.
• Parameters:
  • account: Signal account to listen for incoming messages.

📱 Signal

• Interact with Signal CLI API for various operations.
• Requires Signal CLI API credential.
• Supports the following resources and operations:
  • Message:
    • Send: Send a message to a recipient or group.
      • Parameters: account, recipient, message
  • Group:
    • Create: Create a new group.
      • Parameters: account, name, members
    • List: List all groups.
      • Parameters: account
  • Contact:
    • Update: Update a contact's name.
      • Parameters: account, recipient, name
    • List: List all contacts.
      • Parameters: account
  • Reaction:
    • Send: Send a reaction to a message.
      • Parameters: account, recipient, reaction, targetAuthor, timestamp
    • Remove: Remove a reaction from a message.
      • Parameters: account, recipient, reaction, targetAuthor, timestamp
  • Receipt:
    • Send: Send a receipt (read or viewed) for a message.
      • Parameters: account, recipient, receiptType, timestamp

💻 Development

• Run pnpm dev to start the TypeScript compiler in watch mode.
• Run pnpm lint to check for linting errors.
• Run pnpm test to run integration tests.

Before running the tests, set the ENDPOINT environment variable to the Signal CLI API URL (e.g., "http://127.0.0.1:8085").

For example, you can run the following command in your terminal:

export ENDPOINT="http://127.0.0.1:8085" # signal-cli endpoint
export ACCOUNT_NUMBER="±33620382719" # your phone number in international format

🚀 Release

• Run pnpm release to release a new version of the package.

🤝 Contributing

Contributions are welcome! Please follow these steps to contribute:

1. Fork this repository.
2. Create a new branch for your feature or bug fix.
3. Submit a pull request with a clear description of your changes.
4. Ensure that your code adheres to the existing coding standards and passes all tests.

⚠️ Known Limitations

• This implementation relies on the Signal CLI API, which may have its own limitations and constraints.
• Ensure that the Signal CLI is properly configured and running before using these nodes.
• Some operations may require specific permissions or settings within Signal CLI.

📄 License

MIT